From 202d78cbc2a36be53a33ccd6d5b24ae6f50bf708 Mon Sep 17 00:00:00 2001 From: Jan Tychtl Date: Thu, 12 Mar 2026 10:14:37 +0100 Subject: [PATCH 1/4] chore: regenerate API client from updated OpenAPI spec --- gooddata-api-client/.openapi-generator/FILES | 100 +- gooddata-api-client/README.md | 426 +- gooddata-api-client/docs/AIApi.md | 6 +- gooddata-api-client/docs/AILakeApi.md | 68 + gooddata-api-client/docs/ActionsApi.md | 293 +- .../docs/AnalyticalDashboardControllerApi.md | 673 + .../docs/ApiTokenControllerApi.md | 326 + .../docs/AttributeControllerApi.md | 397 + .../docs/AttributeHierarchiesApi.md | 8 +- .../docs/AttributeHierarchyControllerApi.md | 670 + gooddata-api-client/docs/AttributesApi.md | 8 +- .../docs/AutomationControllerApi.md | 1441 + gooddata-api-client/docs/AutomationsApi.md | 13 +- .../docs/AzureFoundryProviderConfig.md | 2 +- gooddata-api-client/docs/ComputationApi.md | 10 +- ...ookieSecurityConfigurationControllerApi.md | 263 + .../CustomApplicationSettingControllerApi.md | 635 + .../docs/CustomGeoCollectionControllerApi.md | 492 + gooddata-api-client/docs/DashboardContext.md | 14 + .../docs/DashboardContextWidgetsInner.md | 18 + .../docs/DashboardPluginControllerApi.md | 670 + gooddata-api-client/docs/DashboardsApi.md | 8 +- gooddata-api-client/docs/DataFiltersApi.md | 24 +- .../docs/DataSourceControllerApi.md | 572 + .../docs/DatasetControllerApi.md | 392 + gooddata-api-client/docs/DatasetsApi.md | 8 +- gooddata-api-client/docs/EntitiesApi.md | 187 +- .../docs/ExportDefinitionControllerApi.md | 694 + .../docs/ExportDefinitionsApi.md | 8 +- gooddata-api-client/docs/FactControllerApi.md | 392 + gooddata-api-client/docs/FactsApi.md | 8 +- gooddata-api-client/docs/FilterContextApi.md | 8 +- .../docs/FilterContextControllerApi.md | 670 + .../docs/FilterViewControllerApi.md | 689 + gooddata-api-client/docs/FilterViewsApi.md | 8 +- gooddata-api-client/docs/GeographicDataApi.md | 34 +- .../docs/GetServiceStatusResponse.md | 13 + .../docs/InsightWidgetDescriptor.md | 17 + .../docs/InsightWidgetDescriptorAllOf.md | 15 + .../docs/JsonApiLlmProviderIn.md | 2 +- .../docs/JsonApiLlmProviderInAttributes.md | 6 +- ...piLlmProviderInAttributesProviderConfig.md | 4 +- .../docs/JsonApiLlmProviderOut.md | 2 +- .../docs/JsonApiLlmProviderOutWithLinks.md | 2 +- .../docs/JsonApiLlmProviderPatch.md | 2 +- .../docs/JsonApiLlmProviderPatchAttributes.md | 16 - .../docs/JsonApiMetricOutDocument.md | 2 +- .../docs/JsonApiMetricOutList.md | 2 +- .../JsonApiVisualizationObjectOutDocument.md | 2 +- ... JsonApiVisualizationObjectOutIncludes.md} | 2 +- .../docs/JsonApiVisualizationObjectOutList.md | 2 +- gooddata-api-client/docs/JwkControllerApi.md | 501 + gooddata-api-client/docs/LLMProvidersApi.md | 2 +- .../docs/LabelControllerApi.md | 392 + gooddata-api-client/docs/LabelsApi.md | 8 +- gooddata-api-client/docs/LayoutApi.md | 3 + .../docs/ListLlmProviderModelsRequest.md | 12 + ...LlmProviderModelsRequestProviderConfig.md} | 6 +- .../docs/ListLlmProviderModelsResponse.md | 14 + gooddata-api-client/docs/LlmProviderConfig.md | 6 +- .../docs/MetricControllerApi.md | 688 + gooddata-api-client/docs/MetricsApi.md | 8 +- gooddata-api-client/docs/ObjectReference.md | 13 + .../docs/ObjectReferenceGroup.md | 13 + .../docs/OpenAIProviderConfig.md | 2 +- .../docs/OrganizationDeclarativeAPIsApi.md | 1 + ....md => OrganizationEntityControllerApi.md} | 287 +- .../docs/OrganizationModelControllerApi.md | 1767 +- gooddata-api-client/docs/PluginsApi.md | 8 +- .../docs/RichTextWidgetDescriptor.md | 15 + .../docs/RichTextWidgetDescriptorAllOf.md | 13 + gooddata-api-client/docs/Settings.md | 1 + gooddata-api-client/docs/SmartFunctionsApi.md | 273 +- gooddata-api-client/docs/TabularExportApi.md | 1 + .../docs/TestLlmProviderByIdRequest.md | 13 + .../docs/TestLlmProviderDefinitionRequest.md | 2 +- .../docs/TrendingObjectItem.md | 30 + .../docs/TrendingObjectsResult.md | 12 + gooddata-api-client/docs/UIContext.md | 13 + gooddata-api-client/docs/UserContext.md | 6 +- .../docs/UserDataFilterControllerApi.md | 694 + .../docs/UserModelControllerApi.md | 739 - .../docs/UserSettingControllerApi.md | 421 + .../docs/VisualizationObjectApi.md | 8 +- .../docs/VisualizationObjectControllerApi.md | 673 + .../VisualizationSwitcherWidgetDescriptor.md | 18 + ...ualizationSwitcherWidgetDescriptorAllOf.md | 16 + gooddata-api-client/docs/WidgetDescriptor.md | 15 + .../docs/WorkspaceDataFilterControllerApi.md | 688 + ...WorkspaceDataFilterSettingControllerApi.md | 679 + .../docs/WorkspaceObjectControllerApi.md | 12649 +-------- .../docs/WorkspaceSettingControllerApi.md | 635 + .../docs/WorkspacesDeclarativeAPIsApi.md | 1 + .../docs/WorkspacesSettingsApi.md | 14 +- .../gooddata_api_client/api/actions_api.py | 447 +- .../gooddata_api_client/api/ai_api.py | 2 +- .../gooddata_api_client/api/ai_lake_api.py | 133 + .../analytical_dashboard_controller_api.py | 1321 + .../api/api_token_controller_api.py | 667 + .../api/attribute_controller_api.py | 782 + .../api/attribute_hierarchies_api.py | 2 +- ... => attribute_hierarchy_controller_api.py} | 894 +- .../gooddata_api_client/api/attributes_api.py | 2 +- .../api/automation_controller_api.py | 1314 + .../api/automations_api.py | 2 +- .../api/computation_api.py | 18 +- ...e_security_configuration_controller_api.py | 500 + ...stom_application_setting_controller_api.py | 1200 + .../custom_geo_collection_controller_api.py | 940 + .../api/dashboard_plugin_controller_api.py | 1275 + .../gooddata_api_client/api/dashboards_api.py | 2 +- .../api/data_filters_api.py | 6 +- ...r_api.py => data_source_controller_api.py} | 393 +- .../api/dataset_controller_api.py | 785 + .../gooddata_api_client/api/datasets_api.py | 2 +- .../gooddata_api_client/api/entities_api.py | 50 +- .../api/export_definition_controller_api.py | 1305 + .../api/export_definitions_api.py | 2 +- .../api/fact_controller_api.py | 773 + .../gooddata_api_client/api/facts_api.py | 2 +- .../api/filter_context_api.py | 2 +- .../api/filter_context_controller_api.py | 1275 + .../api/filter_view_controller_api.py | 1242 + .../api/filter_views_api.py | 2 +- .../api/geographic_data_api.py | 12 +- .../api/jwk_controller_api.py | 946 + .../api/label_controller_api.py | 773 + .../gooddata_api_client/api/labels_api.py | 2 +- .../api/metric_controller_api.py | 1305 + .../gooddata_api_client/api/metrics_api.py | 2 +- .../api/organization_entity_controller_api.py | 572 + .../api/organization_model_controller_api.py | 5175 +--- .../gooddata_api_client/api/plugins_api.py | 2 +- .../api/smart_functions_api.py | 415 + .../api/user_data_filter_controller_api.py | 1305 + .../api/user_setting_controller_api.py | 834 + .../api/visualization_object_api.py | 2 +- .../visualization_object_controller_api.py | 1305 + .../workspace_data_filter_controller_api.py | 1269 + ...pace_data_filter_setting_controller_api.py | 1269 + .../api/workspace_object_controller_api.py | 21621 +--------------- .../api/workspace_setting_controller_api.py | 1200 + .../api/workspaces_settings_api.py | 4 +- .../gooddata_api_client/apis/__init__.py | 27 +- .../attribute_header_attribute_header.py | 1 + .../model/azure_foundry_provider_config.py | 4 +- .../model/column_override.py | 1 + .../model/dashboard_context.py | 282 + .../model/dashboard_context_widgets_inner.py | 360 + .../dashboard_date_filter_date_filter.py | 6 +- .../model/declarative_label.py | 1 + .../model/declarative_setting.py | 2 +- .../model/get_service_status_response.py | 276 + .../model/insight_widget_descriptor.py | 342 + .../model/insight_widget_descriptor_all_of.py | 276 + .../model/json_api_label_out_attributes.py | 1 + .../model/json_api_llm_provider_in.py | 14 +- .../json_api_llm_provider_in_attributes.py | 32 +- ...llm_provider_in_attributes_models_inner.py | 1 + ..._provider_in_attributes_provider_config.py | 12 +- .../model/json_api_llm_provider_out.py | 14 +- .../json_api_llm_provider_out_with_links.py | 8 +- .../model/json_api_llm_provider_patch.py | 18 +- .../model/json_api_metric_out_document.py | 10 +- .../model/json_api_metric_out_list.py | 10 +- ..._api_organization_setting_in_attributes.py | 2 +- ...n_api_visualization_object_out_document.py | 10 +- ..._api_visualization_object_out_includes.py} | 6 +- .../json_api_visualization_object_out_list.py | 10 +- .../model/key_drivers_dimension.py | 1 + .../model/list_llm_provider_models_request.py | 276 + ...rovider_models_request_provider_config.py} | 16 +- .../list_llm_provider_models_response.py | 288 + .../gooddata_api_client/model/llm_model.py | 1 + .../model/llm_provider_config.py | 10 +- .../model/object_reference.py | 282 + .../model/object_reference_group.py | 280 + .../model/open_ai_provider_config.py | 6 +- .../model/resolved_setting.py | 2 +- .../model/rich_text_widget_descriptor.py | 334 + .../rich_text_widget_descriptor_all_of.py | 268 + .../gooddata_api_client/model/settings.py | 10 + ....py => test_llm_provider_by_id_request.py} | 47 +- .../test_llm_provider_definition_request.py | 10 +- .../model/trending_object_item.py | 348 + .../model/trending_objects_result.py | 276 + .../gooddata_api_client/model/ui_context.py | 270 + .../gooddata_api_client/model/user_context.py | 24 +- ...isualization_switcher_widget_descriptor.py | 346 + ...ation_switcher_widget_descriptor_all_of.py | 280 + .../model/widget_descriptor.py | 299 + .../gooddata_api_client/models/__init__.py | 23 +- schemas/gooddata-afm-client.json | 616 +- schemas/gooddata-api-client.json | 1194 +- schemas/gooddata-automation-client.json | 16 +- schemas/gooddata-export-client.json | 16 +- schemas/gooddata-metadata-client.json | 585 +- 197 files changed, 51245 insertions(+), 41642 deletions(-) create mode 100644 gooddata-api-client/docs/AnalyticalDashboardControllerApi.md create mode 100644 gooddata-api-client/docs/ApiTokenControllerApi.md create mode 100644 gooddata-api-client/docs/AttributeControllerApi.md create mode 100644 gooddata-api-client/docs/AttributeHierarchyControllerApi.md create mode 100644 gooddata-api-client/docs/AutomationControllerApi.md create mode 100644 gooddata-api-client/docs/CookieSecurityConfigurationControllerApi.md create mode 100644 gooddata-api-client/docs/CustomApplicationSettingControllerApi.md create mode 100644 gooddata-api-client/docs/CustomGeoCollectionControllerApi.md create mode 100644 gooddata-api-client/docs/DashboardContext.md create mode 100644 gooddata-api-client/docs/DashboardContextWidgetsInner.md create mode 100644 gooddata-api-client/docs/DashboardPluginControllerApi.md create mode 100644 gooddata-api-client/docs/DataSourceControllerApi.md create mode 100644 gooddata-api-client/docs/DatasetControllerApi.md create mode 100644 gooddata-api-client/docs/ExportDefinitionControllerApi.md create mode 100644 gooddata-api-client/docs/FactControllerApi.md create mode 100644 gooddata-api-client/docs/FilterContextControllerApi.md create mode 100644 gooddata-api-client/docs/FilterViewControllerApi.md create mode 100644 gooddata-api-client/docs/GetServiceStatusResponse.md create mode 100644 gooddata-api-client/docs/InsightWidgetDescriptor.md create mode 100644 gooddata-api-client/docs/InsightWidgetDescriptorAllOf.md delete mode 100644 gooddata-api-client/docs/JsonApiLlmProviderPatchAttributes.md rename gooddata-api-client/docs/{JsonApiMetricOutIncludes.md => JsonApiVisualizationObjectOutIncludes.md} (96%) create mode 100644 gooddata-api-client/docs/JwkControllerApi.md create mode 100644 gooddata-api-client/docs/LabelControllerApi.md create mode 100644 gooddata-api-client/docs/ListLlmProviderModelsRequest.md rename gooddata-api-client/docs/{TestLlmProviderDefinitionRequestProviderConfig.md => ListLlmProviderModelsRequestProviderConfig.md} (73%) create mode 100644 gooddata-api-client/docs/ListLlmProviderModelsResponse.md create mode 100644 gooddata-api-client/docs/MetricControllerApi.md create mode 100644 gooddata-api-client/docs/ObjectReference.md create mode 100644 gooddata-api-client/docs/ObjectReferenceGroup.md rename gooddata-api-client/docs/{OrganizationControllerApi.md => OrganizationEntityControllerApi.md} (50%) create mode 100644 gooddata-api-client/docs/RichTextWidgetDescriptor.md create mode 100644 gooddata-api-client/docs/RichTextWidgetDescriptorAllOf.md create mode 100644 gooddata-api-client/docs/TestLlmProviderByIdRequest.md create mode 100644 gooddata-api-client/docs/TrendingObjectItem.md create mode 100644 gooddata-api-client/docs/TrendingObjectsResult.md create mode 100644 gooddata-api-client/docs/UIContext.md create mode 100644 gooddata-api-client/docs/UserDataFilterControllerApi.md delete mode 100644 gooddata-api-client/docs/UserModelControllerApi.md create mode 100644 gooddata-api-client/docs/UserSettingControllerApi.md create mode 100644 gooddata-api-client/docs/VisualizationObjectControllerApi.md create mode 100644 gooddata-api-client/docs/VisualizationSwitcherWidgetDescriptor.md create mode 100644 gooddata-api-client/docs/VisualizationSwitcherWidgetDescriptorAllOf.md create mode 100644 gooddata-api-client/docs/WidgetDescriptor.md create mode 100644 gooddata-api-client/docs/WorkspaceDataFilterControllerApi.md create mode 100644 gooddata-api-client/docs/WorkspaceDataFilterSettingControllerApi.md create mode 100644 gooddata-api-client/docs/WorkspaceSettingControllerApi.md create mode 100644 gooddata-api-client/gooddata_api_client/api/analytical_dashboard_controller_api.py create mode 100644 gooddata-api-client/gooddata_api_client/api/api_token_controller_api.py create mode 100644 gooddata-api-client/gooddata_api_client/api/attribute_controller_api.py rename gooddata-api-client/gooddata_api_client/api/{user_model_controller_api.py => attribute_hierarchy_controller_api.py} (62%) create mode 100644 gooddata-api-client/gooddata_api_client/api/automation_controller_api.py create mode 100644 gooddata-api-client/gooddata_api_client/api/cookie_security_configuration_controller_api.py create mode 100644 gooddata-api-client/gooddata_api_client/api/custom_application_setting_controller_api.py create mode 100644 gooddata-api-client/gooddata_api_client/api/custom_geo_collection_controller_api.py create mode 100644 gooddata-api-client/gooddata_api_client/api/dashboard_plugin_controller_api.py rename gooddata-api-client/gooddata_api_client/api/{organization_controller_api.py => data_source_controller_api.py} (71%) create mode 100644 gooddata-api-client/gooddata_api_client/api/dataset_controller_api.py create mode 100644 gooddata-api-client/gooddata_api_client/api/export_definition_controller_api.py create mode 100644 gooddata-api-client/gooddata_api_client/api/fact_controller_api.py create mode 100644 gooddata-api-client/gooddata_api_client/api/filter_context_controller_api.py create mode 100644 gooddata-api-client/gooddata_api_client/api/filter_view_controller_api.py create mode 100644 gooddata-api-client/gooddata_api_client/api/jwk_controller_api.py create mode 100644 gooddata-api-client/gooddata_api_client/api/label_controller_api.py create mode 100644 gooddata-api-client/gooddata_api_client/api/metric_controller_api.py create mode 100644 gooddata-api-client/gooddata_api_client/api/organization_entity_controller_api.py create mode 100644 gooddata-api-client/gooddata_api_client/api/user_data_filter_controller_api.py create mode 100644 gooddata-api-client/gooddata_api_client/api/user_setting_controller_api.py create mode 100644 gooddata-api-client/gooddata_api_client/api/visualization_object_controller_api.py create mode 100644 gooddata-api-client/gooddata_api_client/api/workspace_data_filter_controller_api.py create mode 100644 gooddata-api-client/gooddata_api_client/api/workspace_data_filter_setting_controller_api.py create mode 100644 gooddata-api-client/gooddata_api_client/api/workspace_setting_controller_api.py create mode 100644 gooddata-api-client/gooddata_api_client/model/dashboard_context.py create mode 100644 gooddata-api-client/gooddata_api_client/model/dashboard_context_widgets_inner.py create mode 100644 gooddata-api-client/gooddata_api_client/model/get_service_status_response.py create mode 100644 gooddata-api-client/gooddata_api_client/model/insight_widget_descriptor.py create mode 100644 gooddata-api-client/gooddata_api_client/model/insight_widget_descriptor_all_of.py rename gooddata-api-client/gooddata_api_client/model/{json_api_metric_out_includes.py => json_api_visualization_object_out_includes.py} (98%) create mode 100644 gooddata-api-client/gooddata_api_client/model/list_llm_provider_models_request.py rename gooddata-api-client/gooddata_api_client/model/{test_llm_provider_definition_request_provider_config.py => list_llm_provider_models_request_provider_config.py} (94%) create mode 100644 gooddata-api-client/gooddata_api_client/model/list_llm_provider_models_response.py create mode 100644 gooddata-api-client/gooddata_api_client/model/object_reference.py create mode 100644 gooddata-api-client/gooddata_api_client/model/object_reference_group.py create mode 100644 gooddata-api-client/gooddata_api_client/model/rich_text_widget_descriptor.py create mode 100644 gooddata-api-client/gooddata_api_client/model/rich_text_widget_descriptor_all_of.py rename gooddata-api-client/gooddata_api_client/model/{json_api_llm_provider_patch_attributes.py => test_llm_provider_by_id_request.py} (81%) create mode 100644 gooddata-api-client/gooddata_api_client/model/trending_object_item.py create mode 100644 gooddata-api-client/gooddata_api_client/model/trending_objects_result.py create mode 100644 gooddata-api-client/gooddata_api_client/model/ui_context.py create mode 100644 gooddata-api-client/gooddata_api_client/model/visualization_switcher_widget_descriptor.py create mode 100644 gooddata-api-client/gooddata_api_client/model/visualization_switcher_widget_descriptor_all_of.py create mode 100644 gooddata-api-client/gooddata_api_client/model/widget_descriptor.py diff --git a/gooddata-api-client/.openapi-generator/FILES b/gooddata-api-client/.openapi-generator/FILES index 07aa05f83..a0ee44702 100644 --- a/gooddata-api-client/.openapi-generator/FILES +++ b/gooddata-api-client/.openapi-generator/FILES @@ -87,6 +87,7 @@ docs/AlertEvaluationRow.md docs/AllTimeDateFilter.md docs/AllTimeDateFilterAllTimeDateFilter.md docs/AllowedRelationshipType.md +docs/AnalyticalDashboardControllerApi.md docs/AnalyticsCatalogCreatedBy.md docs/AnalyticsCatalogTags.md docs/AnalyticsCatalogUser.md @@ -97,6 +98,7 @@ docs/AnomalyDetectionRequest.md docs/AnomalyDetectionResult.md docs/AnomalyDetectionWrapper.md docs/ApiEntitlement.md +docs/ApiTokenControllerApi.md docs/AppearanceApi.md docs/ArithmeticMeasure.md docs/ArithmeticMeasureDefinition.md @@ -104,6 +106,7 @@ docs/ArithmeticMeasureDefinitionArithmeticMeasure.md docs/Array.md docs/AssigneeIdentifier.md docs/AssigneeRule.md +docs/AttributeControllerApi.md docs/AttributeElements.md docs/AttributeElementsByRef.md docs/AttributeElementsByValue.md @@ -116,6 +119,7 @@ docs/AttributeFormat.md docs/AttributeHeader.md docs/AttributeHeaderAttributeHeader.md docs/AttributeHierarchiesApi.md +docs/AttributeHierarchyControllerApi.md docs/AttributeItem.md docs/AttributeNegativeFilter.md docs/AttributeNegativeFilterAllOf.md @@ -125,6 +129,7 @@ docs/AttributeResultHeader.md docs/AttributesApi.md docs/AutomationAlert.md docs/AutomationAlertCondition.md +docs/AutomationControllerApi.md docs/AutomationDashboardTabularExport.md docs/AutomationExternalRecipient.md docs/AutomationImageExport.md @@ -184,23 +189,29 @@ docs/CompoundMeasureValueFilterCompoundMeasureValueFilter.md docs/ComputationApi.md docs/ContentSlideTemplate.md docs/CookieSecurityConfigurationApi.md +docs/CookieSecurityConfigurationControllerApi.md docs/CoverSlideTemplate.md docs/CreateKnowledgeDocumentRequestDto.md docs/CreateKnowledgeDocumentResponseDto.md docs/CreatedVisualization.md docs/CreatedVisualizationFiltersInner.md docs/CreatedVisualizations.md +docs/CustomApplicationSettingControllerApi.md +docs/CustomGeoCollectionControllerApi.md docs/CustomLabel.md docs/CustomMetric.md docs/CustomOverride.md docs/DashboardAttributeFilter.md docs/DashboardAttributeFilterAttributeFilter.md +docs/DashboardContext.md +docs/DashboardContextWidgetsInner.md docs/DashboardDateFilter.md docs/DashboardDateFilterDateFilter.md docs/DashboardExportSettings.md docs/DashboardFilter.md docs/DashboardPermissions.md docs/DashboardPermissionsAssignment.md +docs/DashboardPluginControllerApi.md docs/DashboardSlidesTemplate.md docs/DashboardTabularExportRequest.md docs/DashboardTabularExportRequestV2.md @@ -208,6 +219,7 @@ docs/DashboardsApi.md docs/DataColumnLocator.md docs/DataColumnLocators.md docs/DataFiltersApi.md +docs/DataSourceControllerApi.md docs/DataSourceDeclarativeAPIsApi.md docs/DataSourceEntityAPIsApi.md docs/DataSourceParameter.md @@ -215,6 +227,7 @@ docs/DataSourcePermissionAssignment.md docs/DataSourceSchemata.md docs/DataSourceTableIdentifier.md docs/DatabaseInstance.md +docs/DatasetControllerApi.md docs/DatasetGrain.md docs/DatasetReferenceIdentifier.md docs/DatasetWorkspaceDataFilterIdentifier.md @@ -349,11 +362,13 @@ docs/ExecutionResultHeader.md docs/ExecutionResultMetadata.md docs/ExecutionResultPaging.md docs/ExecutionSettings.md +docs/ExportDefinitionControllerApi.md docs/ExportDefinitionsApi.md docs/ExportRequest.md docs/ExportResponse.md docs/ExportResult.md docs/ExportTemplatesApi.md +docs/FactControllerApi.md docs/FactIdentifier.md docs/FactsApi.md docs/FailedOperation.md @@ -362,8 +377,10 @@ docs/File.md docs/Filter.md docs/FilterBy.md docs/FilterContextApi.md +docs/FilterContextControllerApi.md docs/FilterDefinition.md docs/FilterDefinitionForSimpleMeasure.md +docs/FilterViewControllerApi.md docs/FilterViewsApi.md docs/ForecastConfig.md docs/ForecastRequest.md @@ -384,6 +401,7 @@ docs/GeographicDataApi.md docs/GetAiLakeOperation200Response.md docs/GetImageExport202ResponseInner.md docs/GetQualityIssuesResponse.md +docs/GetServiceStatusResponse.md docs/GrainIdentifier.md docs/GrantedPermission.md docs/GranularitiesFormatting.md @@ -405,6 +423,8 @@ docs/InlineFilterDefinition.md docs/InlineFilterDefinitionInline.md docs/InlineMeasureDefinition.md docs/InlineMeasureDefinitionInline.md +docs/InsightWidgetDescriptor.md +docs/InsightWidgetDescriptorAllOf.md docs/IntroSlideTemplate.md docs/InvalidateCacheApi.md docs/JWKSApi.md @@ -779,7 +799,6 @@ docs/JsonApiLlmProviderOutDocument.md docs/JsonApiLlmProviderOutList.md docs/JsonApiLlmProviderOutWithLinks.md docs/JsonApiLlmProviderPatch.md -docs/JsonApiLlmProviderPatchAttributes.md docs/JsonApiLlmProviderPatchDocument.md docs/JsonApiMemoryItemIn.md docs/JsonApiMemoryItemInAttributes.md @@ -802,7 +821,6 @@ docs/JsonApiMetricLinkage.md docs/JsonApiMetricOut.md docs/JsonApiMetricOutAttributes.md docs/JsonApiMetricOutDocument.md -docs/JsonApiMetricOutIncludes.md docs/JsonApiMetricOutList.md docs/JsonApiMetricOutRelationships.md docs/JsonApiMetricOutWithLinks.md @@ -927,6 +945,7 @@ docs/JsonApiVisualizationObjectLinkage.md docs/JsonApiVisualizationObjectOut.md docs/JsonApiVisualizationObjectOutAttributes.md docs/JsonApiVisualizationObjectOutDocument.md +docs/JsonApiVisualizationObjectOutIncludes.md docs/JsonApiVisualizationObjectOutList.md docs/JsonApiVisualizationObjectOutWithLinks.md docs/JsonApiVisualizationObjectPatch.md @@ -998,6 +1017,7 @@ docs/JsonApiWorkspaceSettingPostOptionalId.md docs/JsonApiWorkspaceSettingPostOptionalIdDocument.md docs/JsonApiWorkspaceToOneLinkage.md docs/JsonNode.md +docs/JwkControllerApi.md docs/KeyDriversDimension.md docs/KeyDriversRequest.md docs/KeyDriversResponse.md @@ -1007,6 +1027,7 @@ docs/KnowledgeSearchResultDto.md docs/LDMDeclarativeAPIsApi.md docs/LLMEndpointsApi.md docs/LLMProvidersApi.md +docs/LabelControllerApi.md docs/LabelIdentifier.md docs/LabelsApi.md docs/LayoutApi.md @@ -1014,6 +1035,9 @@ docs/ListDatabaseInstancesResponse.md docs/ListKnowledgeDocumentsResponseDto.md docs/ListLinks.md docs/ListLinksAllOf.md +docs/ListLlmProviderModelsRequest.md +docs/ListLlmProviderModelsRequestProviderConfig.md +docs/ListLlmProviderModelsResponse.md docs/ListServicesResponse.md docs/LlmModel.md docs/LlmProviderAuth.md @@ -1038,6 +1062,7 @@ docs/MemoryItemUser.md docs/MetadataCheckApi.md docs/MetadataSyncApi.md docs/Metric.md +docs/MetricControllerApi.md docs/MetricDefinitionOverride.md docs/MetricRecord.md docs/MetricValueChange.md @@ -1058,6 +1083,8 @@ docs/NotificationsMeta.md docs/NotificationsMetaTotal.md docs/ObjectLinks.md docs/ObjectLinksContainer.md +docs/ObjectReference.md +docs/ObjectReferenceGroup.md docs/OpenAIProviderConfig.md docs/OpenAiApiKeyAuth.md docs/OpenAiApiKeyAuthAllOf.md @@ -1068,9 +1095,9 @@ docs/OptionsApi.md docs/OrganizationApi.md docs/OrganizationAutomationIdentifier.md docs/OrganizationAutomationManagementBulkRequest.md -docs/OrganizationControllerApi.md docs/OrganizationDeclarativeAPIsApi.md docs/OrganizationEntityAPIsApi.md +docs/OrganizationEntityControllerApi.md docs/OrganizationModelControllerApi.md docs/OrganizationPermissionAssignment.md docs/OutlierDetectionRequest.md @@ -1140,6 +1167,8 @@ docs/ResultCacheMetadata.md docs/ResultDimension.md docs/ResultDimensionHeader.md docs/ResultSpec.md +docs/RichTextWidgetDescriptor.md +docs/RichTextWidgetDescriptorAllOf.md docs/RouteResult.md docs/RsaSpecification.md docs/RulePermission.md @@ -1193,8 +1222,8 @@ docs/TabularExportRequest.md docs/TestConnectionApi.md docs/TestDefinitionRequest.md docs/TestDestinationRequest.md +docs/TestLlmProviderByIdRequest.md docs/TestLlmProviderDefinitionRequest.md -docs/TestLlmProviderDefinitionRequestProviderConfig.md docs/TestLlmProviderResponse.md docs/TestNotification.md docs/TestNotificationAllOf.md @@ -1207,13 +1236,17 @@ docs/TotalDimension.md docs/TotalExecutionResultHeader.md docs/TotalResultHeader.md docs/TranslationsApi.md +docs/TrendingObjectItem.md +docs/TrendingObjectsResult.md docs/TriggerAutomationRequest.md docs/TriggerQualityIssuesCalculationResponse.md +docs/UIContext.md docs/UpsertKnowledgeDocumentRequestDto.md docs/UpsertKnowledgeDocumentResponseDto.md docs/UsageApi.md docs/UserAssignee.md docs/UserContext.md +docs/UserDataFilterControllerApi.md docs/UserDataFiltersApi.md docs/UserGroupAssignee.md docs/UserGroupIdentifier.md @@ -1231,8 +1264,8 @@ docs/UserManagementUserGroupsItem.md docs/UserManagementUsers.md docs/UserManagementUsersItem.md docs/UserManagementWorkspacePermissionAssignment.md -docs/UserModelControllerApi.md docs/UserPermission.md +docs/UserSettingControllerApi.md docs/UserSettingsApi.md docs/UsersDeclarativeAPIsApi.md docs/UsersEntityAPIsApi.md @@ -1246,6 +1279,9 @@ docs/VisualExportApi.md docs/VisualExportRequest.md docs/VisualizationConfig.md docs/VisualizationObjectApi.md +docs/VisualizationObjectControllerApi.md +docs/VisualizationSwitcherWidgetDescriptor.md +docs/VisualizationSwitcherWidgetDescriptorAllOf.md docs/Webhook.md docs/WebhookAllOf.md docs/WebhookAutomationInfo.md @@ -1255,13 +1291,17 @@ docs/WebhookRecipient.md docs/WhatIfMeasureAdjustmentConfig.md docs/WhatIfScenarioConfig.md docs/WhatIfScenarioItem.md +docs/WidgetDescriptor.md docs/WidgetSlidesTemplate.md docs/WorkspaceAutomationIdentifier.md docs/WorkspaceAutomationManagementBulkRequest.md +docs/WorkspaceDataFilterControllerApi.md +docs/WorkspaceDataFilterSettingControllerApi.md docs/WorkspaceDataSource.md docs/WorkspaceIdentifier.md docs/WorkspaceObjectControllerApi.md docs/WorkspacePermissionAssignment.md +docs/WorkspaceSettingControllerApi.md docs/WorkspaceUser.md docs/WorkspaceUserGroup.md docs/WorkspaceUserGroups.md @@ -1278,30 +1318,45 @@ gooddata_api_client/api/aac_logical_data_model_api.py gooddata_api_client/api/actions_api.py gooddata_api_client/api/ai_api.py gooddata_api_client/api/ai_lake_api.py +gooddata_api_client/api/analytical_dashboard_controller_api.py gooddata_api_client/api/analytics_model_api.py +gooddata_api_client/api/api_token_controller_api.py gooddata_api_client/api/api_tokens_api.py gooddata_api_client/api/appearance_api.py +gooddata_api_client/api/attribute_controller_api.py gooddata_api_client/api/attribute_hierarchies_api.py +gooddata_api_client/api/attribute_hierarchy_controller_api.py gooddata_api_client/api/attributes_api.py +gooddata_api_client/api/automation_controller_api.py gooddata_api_client/api/automation_organization_view_controller_api.py gooddata_api_client/api/automations_api.py gooddata_api_client/api/available_drivers_api.py gooddata_api_client/api/certification_api.py gooddata_api_client/api/computation_api.py gooddata_api_client/api/cookie_security_configuration_api.py +gooddata_api_client/api/cookie_security_configuration_controller_api.py gooddata_api_client/api/csp_directives_api.py +gooddata_api_client/api/custom_application_setting_controller_api.py +gooddata_api_client/api/custom_geo_collection_controller_api.py +gooddata_api_client/api/dashboard_plugin_controller_api.py gooddata_api_client/api/dashboards_api.py gooddata_api_client/api/data_filters_api.py +gooddata_api_client/api/data_source_controller_api.py gooddata_api_client/api/data_source_declarative_apis_api.py gooddata_api_client/api/data_source_entity_apis_api.py +gooddata_api_client/api/dataset_controller_api.py gooddata_api_client/api/datasets_api.py gooddata_api_client/api/dependency_graph_api.py gooddata_api_client/api/entities_api.py gooddata_api_client/api/entitlement_api.py +gooddata_api_client/api/export_definition_controller_api.py gooddata_api_client/api/export_definitions_api.py gooddata_api_client/api/export_templates_api.py +gooddata_api_client/api/fact_controller_api.py gooddata_api_client/api/facts_api.py gooddata_api_client/api/filter_context_api.py +gooddata_api_client/api/filter_context_controller_api.py +gooddata_api_client/api/filter_view_controller_api.py gooddata_api_client/api/filter_views_api.py gooddata_api_client/api/generate_logical_data_model_api.py gooddata_api_client/api/geographic_data_api.py @@ -1309,7 +1364,9 @@ gooddata_api_client/api/hierarchy_api.py gooddata_api_client/api/identity_providers_api.py gooddata_api_client/api/image_export_api.py gooddata_api_client/api/invalidate_cache_api.py +gooddata_api_client/api/jwk_controller_api.py gooddata_api_client/api/jwks_api.py +gooddata_api_client/api/label_controller_api.py gooddata_api_client/api/labels_api.py gooddata_api_client/api/layout_api.py gooddata_api_client/api/ldm_declarative_apis_api.py @@ -1318,13 +1375,14 @@ gooddata_api_client/api/llm_providers_api.py gooddata_api_client/api/manage_permissions_api.py gooddata_api_client/api/metadata_check_api.py gooddata_api_client/api/metadata_sync_api.py +gooddata_api_client/api/metric_controller_api.py gooddata_api_client/api/metrics_api.py gooddata_api_client/api/notification_channels_api.py gooddata_api_client/api/options_api.py gooddata_api_client/api/organization_api.py -gooddata_api_client/api/organization_controller_api.py gooddata_api_client/api/organization_declarative_apis_api.py gooddata_api_client/api/organization_entity_apis_api.py +gooddata_api_client/api/organization_entity_controller_api.py gooddata_api_client/api/organization_model_controller_api.py gooddata_api_client/api/permissions_api.py gooddata_api_client/api/plugins_api.py @@ -1337,18 +1395,23 @@ gooddata_api_client/api/tabular_export_api.py gooddata_api_client/api/test_connection_api.py gooddata_api_client/api/translations_api.py gooddata_api_client/api/usage_api.py +gooddata_api_client/api/user_data_filter_controller_api.py gooddata_api_client/api/user_data_filters_api.py gooddata_api_client/api/user_groups_declarative_apis_api.py gooddata_api_client/api/user_groups_entity_apis_api.py gooddata_api_client/api/user_identifiers_api.py gooddata_api_client/api/user_management_api.py -gooddata_api_client/api/user_model_controller_api.py +gooddata_api_client/api/user_setting_controller_api.py gooddata_api_client/api/user_settings_api.py gooddata_api_client/api/users_declarative_apis_api.py gooddata_api_client/api/users_entity_apis_api.py gooddata_api_client/api/visual_export_api.py gooddata_api_client/api/visualization_object_api.py +gooddata_api_client/api/visualization_object_controller_api.py +gooddata_api_client/api/workspace_data_filter_controller_api.py +gooddata_api_client/api/workspace_data_filter_setting_controller_api.py gooddata_api_client/api/workspace_object_controller_api.py +gooddata_api_client/api/workspace_setting_controller_api.py gooddata_api_client/api/workspaces_declarative_apis_api.py gooddata_api_client/api/workspaces_entity_apis_api.py gooddata_api_client/api/workspaces_settings_api.py @@ -1534,6 +1597,8 @@ gooddata_api_client/model/custom_metric.py gooddata_api_client/model/custom_override.py gooddata_api_client/model/dashboard_attribute_filter.py gooddata_api_client/model/dashboard_attribute_filter_attribute_filter.py +gooddata_api_client/model/dashboard_context.py +gooddata_api_client/model/dashboard_context_widgets_inner.py gooddata_api_client/model/dashboard_date_filter.py gooddata_api_client/model/dashboard_date_filter_date_filter.py gooddata_api_client/model/dashboard_export_settings.py @@ -1708,6 +1773,7 @@ gooddata_api_client/model/geo_collection_identifier.py gooddata_api_client/model/get_ai_lake_operation200_response.py gooddata_api_client/model/get_image_export202_response_inner.py gooddata_api_client/model/get_quality_issues_response.py +gooddata_api_client/model/get_service_status_response.py gooddata_api_client/model/grain_identifier.py gooddata_api_client/model/granted_permission.py gooddata_api_client/model/granularities_formatting.py @@ -1726,6 +1792,8 @@ gooddata_api_client/model/inline_filter_definition.py gooddata_api_client/model/inline_filter_definition_inline.py gooddata_api_client/model/inline_measure_definition.py gooddata_api_client/model/inline_measure_definition_inline.py +gooddata_api_client/model/insight_widget_descriptor.py +gooddata_api_client/model/insight_widget_descriptor_all_of.py gooddata_api_client/model/intro_slide_template.py gooddata_api_client/model/json_api_aggregated_fact_linkage.py gooddata_api_client/model/json_api_aggregated_fact_out.py @@ -2098,7 +2166,6 @@ gooddata_api_client/model/json_api_llm_provider_out_document.py gooddata_api_client/model/json_api_llm_provider_out_list.py gooddata_api_client/model/json_api_llm_provider_out_with_links.py gooddata_api_client/model/json_api_llm_provider_patch.py -gooddata_api_client/model/json_api_llm_provider_patch_attributes.py gooddata_api_client/model/json_api_llm_provider_patch_document.py gooddata_api_client/model/json_api_memory_item_in.py gooddata_api_client/model/json_api_memory_item_in_attributes.py @@ -2121,7 +2188,6 @@ gooddata_api_client/model/json_api_metric_linkage.py gooddata_api_client/model/json_api_metric_out.py gooddata_api_client/model/json_api_metric_out_attributes.py gooddata_api_client/model/json_api_metric_out_document.py -gooddata_api_client/model/json_api_metric_out_includes.py gooddata_api_client/model/json_api_metric_out_list.py gooddata_api_client/model/json_api_metric_out_relationships.py gooddata_api_client/model/json_api_metric_out_with_links.py @@ -2246,6 +2312,7 @@ gooddata_api_client/model/json_api_visualization_object_linkage.py gooddata_api_client/model/json_api_visualization_object_out.py gooddata_api_client/model/json_api_visualization_object_out_attributes.py gooddata_api_client/model/json_api_visualization_object_out_document.py +gooddata_api_client/model/json_api_visualization_object_out_includes.py gooddata_api_client/model/json_api_visualization_object_out_list.py gooddata_api_client/model/json_api_visualization_object_out_with_links.py gooddata_api_client/model/json_api_visualization_object_patch.py @@ -2328,6 +2395,9 @@ gooddata_api_client/model/list_database_instances_response.py gooddata_api_client/model/list_knowledge_documents_response_dto.py gooddata_api_client/model/list_links.py gooddata_api_client/model/list_links_all_of.py +gooddata_api_client/model/list_llm_provider_models_request.py +gooddata_api_client/model/list_llm_provider_models_request_provider_config.py +gooddata_api_client/model/list_llm_provider_models_response.py gooddata_api_client/model/list_services_response.py gooddata_api_client/model/llm_model.py gooddata_api_client/model/llm_provider_auth.py @@ -2367,6 +2437,8 @@ gooddata_api_client/model/notifications_meta.py gooddata_api_client/model/notifications_meta_total.py gooddata_api_client/model/object_links.py gooddata_api_client/model/object_links_container.py +gooddata_api_client/model/object_reference.py +gooddata_api_client/model/object_reference_group.py gooddata_api_client/model/open_ai_api_key_auth.py gooddata_api_client/model/open_ai_api_key_auth_all_of.py gooddata_api_client/model/open_ai_provider_auth.py @@ -2439,6 +2511,8 @@ gooddata_api_client/model/result_cache_metadata.py gooddata_api_client/model/result_dimension.py gooddata_api_client/model/result_dimension_header.py gooddata_api_client/model/result_spec.py +gooddata_api_client/model/rich_text_widget_descriptor.py +gooddata_api_client/model/rich_text_widget_descriptor_all_of.py gooddata_api_client/model/route_result.py gooddata_api_client/model/rsa_specification.py gooddata_api_client/model/rule_permission.py @@ -2487,8 +2561,8 @@ gooddata_api_client/model/table_warning.py gooddata_api_client/model/tabular_export_request.py gooddata_api_client/model/test_definition_request.py gooddata_api_client/model/test_destination_request.py +gooddata_api_client/model/test_llm_provider_by_id_request.py gooddata_api_client/model/test_llm_provider_definition_request.py -gooddata_api_client/model/test_llm_provider_definition_request_provider_config.py gooddata_api_client/model/test_llm_provider_response.py gooddata_api_client/model/test_notification.py gooddata_api_client/model/test_notification_all_of.py @@ -2500,8 +2574,11 @@ gooddata_api_client/model/total.py gooddata_api_client/model/total_dimension.py gooddata_api_client/model/total_execution_result_header.py gooddata_api_client/model/total_result_header.py +gooddata_api_client/model/trending_object_item.py +gooddata_api_client/model/trending_objects_result.py gooddata_api_client/model/trigger_automation_request.py gooddata_api_client/model/trigger_quality_issues_calculation_response.py +gooddata_api_client/model/ui_context.py gooddata_api_client/model/upsert_knowledge_document_request_dto.py gooddata_api_client/model/upsert_knowledge_document_response_dto.py gooddata_api_client/model/user_assignee.py @@ -2527,6 +2604,8 @@ gooddata_api_client/model/value.py gooddata_api_client/model/visible_filter.py gooddata_api_client/model/visual_export_request.py gooddata_api_client/model/visualization_config.py +gooddata_api_client/model/visualization_switcher_widget_descriptor.py +gooddata_api_client/model/visualization_switcher_widget_descriptor_all_of.py gooddata_api_client/model/webhook.py gooddata_api_client/model/webhook_all_of.py gooddata_api_client/model/webhook_automation_info.py @@ -2536,6 +2615,7 @@ gooddata_api_client/model/webhook_recipient.py gooddata_api_client/model/what_if_measure_adjustment_config.py gooddata_api_client/model/what_if_scenario_config.py gooddata_api_client/model/what_if_scenario_item.py +gooddata_api_client/model/widget_descriptor.py gooddata_api_client/model/widget_slides_template.py gooddata_api_client/model/workspace_automation_identifier.py gooddata_api_client/model/workspace_automation_management_bulk_request.py diff --git a/gooddata-api-client/README.md b/gooddata-api-client/README.md index 097ee2f03..887dc08f0 100644 --- a/gooddata-api-client/README.md +++ b/gooddata-api-client/README.md @@ -99,13 +99,14 @@ Class | Method | HTTP request | Description *AIApi* | [**metadata_sync_organization**](docs/AIApi.md#metadata_sync_organization) | **POST** /api/v1/actions/organization/metadataSync | (BETA) Sync organization scope Metadata to other services *AIApi* | [**patch_entity_knowledge_recommendations**](docs/AIApi.md#patch_entity_knowledge_recommendations) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | *AIApi* | [**patch_entity_memory_items**](docs/AIApi.md#patch_entity_memory_items) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | -*AIApi* | [**search_entities_knowledge_recommendations**](docs/AIApi.md#search_entities_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search | +*AIApi* | [**search_entities_knowledge_recommendations**](docs/AIApi.md#search_entities_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search | The search endpoint (beta) *AIApi* | [**search_entities_memory_items**](docs/AIApi.md#search_entities_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems/search | Search request for MemoryItem *AIApi* | [**update_entity_knowledge_recommendations**](docs/AIApi.md#update_entity_knowledge_recommendations) | **PUT** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | *AIApi* | [**update_entity_memory_items**](docs/AIApi.md#update_entity_memory_items) | **PUT** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | *AILakeApi* | [**deprovision_ai_lake_database_instance**](docs/AILakeApi.md#deprovision_ai_lake_database_instance) | **DELETE** /api/v1/ailake/database/instances/{instanceId} | (BETA) Delete an existing AILake Database instance *AILakeApi* | [**get_ai_lake_database_instance**](docs/AILakeApi.md#get_ai_lake_database_instance) | **GET** /api/v1/ailake/database/instances/{instanceId} | (BETA) Get the specified AILake Database instance *AILakeApi* | [**get_ai_lake_operation**](docs/AILakeApi.md#get_ai_lake_operation) | **GET** /api/v1/ailake/operations/{operationId} | (BETA) Get Long Running Operation details +*AILakeApi* | [**get_ai_lake_service_status**](docs/AILakeApi.md#get_ai_lake_service_status) | **GET** /api/v1/ailake/services/{serviceId}/status | (BETA) Get AI Lake service status *AILakeApi* | [**list_ai_lake_database_instances**](docs/AILakeApi.md#list_ai_lake_database_instances) | **GET** /api/v1/ailake/database/instances | (BETA) List AI Lake Database instances *AILakeApi* | [**list_ai_lake_services**](docs/AILakeApi.md#list_ai_lake_services) | **GET** /api/v1/ailake/services | (BETA) List AI Lake services *AILakeApi* | [**provision_ai_lake_database_instance**](docs/AILakeApi.md#provision_ai_lake_database_instance) | **POST** /api/v1/ailake/database/instances | (BETA) Create a new AILake Database instance @@ -133,12 +134,12 @@ Class | Method | HTTP request | Description *AttributeHierarchiesApi* | [**get_all_entities_attribute_hierarchies**](docs/AttributeHierarchiesApi.md#get_all_entities_attribute_hierarchies) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies | Get all Attribute Hierarchies *AttributeHierarchiesApi* | [**get_entity_attribute_hierarchies**](docs/AttributeHierarchiesApi.md#get_entity_attribute_hierarchies) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Get an Attribute Hierarchy *AttributeHierarchiesApi* | [**patch_entity_attribute_hierarchies**](docs/AttributeHierarchiesApi.md#patch_entity_attribute_hierarchies) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Patch an Attribute Hierarchy -*AttributeHierarchiesApi* | [**search_entities_attribute_hierarchies**](docs/AttributeHierarchiesApi.md#search_entities_attribute_hierarchies) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search | Search request for AttributeHierarchy +*AttributeHierarchiesApi* | [**search_entities_attribute_hierarchies**](docs/AttributeHierarchiesApi.md#search_entities_attribute_hierarchies) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search | The search endpoint (beta) *AttributeHierarchiesApi* | [**update_entity_attribute_hierarchies**](docs/AttributeHierarchiesApi.md#update_entity_attribute_hierarchies) | **PUT** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Put an Attribute Hierarchy *AttributesApi* | [**get_all_entities_attributes**](docs/AttributesApi.md#get_all_entities_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributes | Get all Attributes *AttributesApi* | [**get_entity_attributes**](docs/AttributesApi.md#get_entity_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId} | Get an Attribute *AttributesApi* | [**patch_entity_attributes**](docs/AttributesApi.md#patch_entity_attributes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId} | Patch an Attribute (beta) -*AttributesApi* | [**search_entities_attributes**](docs/AttributesApi.md#search_entities_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributes/search | Search request for Attribute +*AttributesApi* | [**search_entities_attributes**](docs/AttributesApi.md#search_entities_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributes/search | The search endpoint (beta) *AutomationsApi* | [**create_entity_automations**](docs/AutomationsApi.md#create_entity_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations | Post Automations *AutomationsApi* | [**delete_entity_automations**](docs/AutomationsApi.md#delete_entity_automations) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Delete an Automation *AutomationsApi* | [**delete_organization_automations**](docs/AutomationsApi.md#delete_organization_automations) | **POST** /api/v1/actions/organization/automations/delete | Delete selected automations across all workspaces @@ -151,7 +152,7 @@ Class | Method | HTTP request | Description *AutomationsApi* | [**pause_organization_automations**](docs/AutomationsApi.md#pause_organization_automations) | **POST** /api/v1/actions/organization/automations/pause | Pause selected automations across all workspaces *AutomationsApi* | [**pause_workspace_automations**](docs/AutomationsApi.md#pause_workspace_automations) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/pause | Pause selected automations in the workspace *AutomationsApi* | [**search_entities_automation_results**](docs/AutomationsApi.md#search_entities_automation_results) | **POST** /api/v1/entities/workspaces/{workspaceId}/automationResults/search | Search request for AutomationResult -*AutomationsApi* | [**search_entities_automations**](docs/AutomationsApi.md#search_entities_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations/search | Search request for Automation +*AutomationsApi* | [**search_entities_automations**](docs/AutomationsApi.md#search_entities_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations/search | The search endpoint (beta) *AutomationsApi* | [**set_automations**](docs/AutomationsApi.md#set_automations) | **PUT** /api/v1/layout/workspaces/{workspaceId}/automations | Set automations *AutomationsApi* | [**trigger_automation**](docs/AutomationsApi.md#trigger_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/trigger | Trigger automation. *AutomationsApi* | [**trigger_existing_automation**](docs/AutomationsApi.md#trigger_existing_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/trigger | Trigger existing automation. @@ -194,7 +195,7 @@ Class | Method | HTTP request | Description *DashboardsApi* | [**get_all_entities_analytical_dashboards**](docs/DashboardsApi.md#get_all_entities_analytical_dashboards) | **GET** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards | Get all Dashboards *DashboardsApi* | [**get_entity_analytical_dashboards**](docs/DashboardsApi.md#get_entity_analytical_dashboards) | **GET** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Get a Dashboard *DashboardsApi* | [**patch_entity_analytical_dashboards**](docs/DashboardsApi.md#patch_entity_analytical_dashboards) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Patch a Dashboard -*DashboardsApi* | [**search_entities_analytical_dashboards**](docs/DashboardsApi.md#search_entities_analytical_dashboards) | **POST** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search | Search request for AnalyticalDashboard +*DashboardsApi* | [**search_entities_analytical_dashboards**](docs/DashboardsApi.md#search_entities_analytical_dashboards) | **POST** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search | The search endpoint (beta) *DashboardsApi* | [**update_entity_analytical_dashboards**](docs/DashboardsApi.md#update_entity_analytical_dashboards) | **PUT** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Put Dashboards *DataFiltersApi* | [**create_entity_user_data_filters**](docs/DataFiltersApi.md#create_entity_user_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/userDataFilters | Post User Data Filters *DataFiltersApi* | [**create_entity_workspace_data_filter_settings**](docs/DataFiltersApi.md#create_entity_workspace_data_filter_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings | Post Settings for Workspace Data Filters @@ -212,9 +213,9 @@ Class | Method | HTTP request | Description *DataFiltersApi* | [**patch_entity_user_data_filters**](docs/DataFiltersApi.md#patch_entity_user_data_filters) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Patch a User Data Filter *DataFiltersApi* | [**patch_entity_workspace_data_filter_settings**](docs/DataFiltersApi.md#patch_entity_workspace_data_filter_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Patch a Settings for Workspace Data Filter *DataFiltersApi* | [**patch_entity_workspace_data_filters**](docs/DataFiltersApi.md#patch_entity_workspace_data_filters) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Patch a Workspace Data Filter -*DataFiltersApi* | [**search_entities_user_data_filters**](docs/DataFiltersApi.md#search_entities_user_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/search | Search request for UserDataFilter -*DataFiltersApi* | [**search_entities_workspace_data_filter_settings**](docs/DataFiltersApi.md#search_entities_workspace_data_filter_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/search | Search request for WorkspaceDataFilterSetting -*DataFiltersApi* | [**search_entities_workspace_data_filters**](docs/DataFiltersApi.md#search_entities_workspace_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/search | Search request for WorkspaceDataFilter +*DataFiltersApi* | [**search_entities_user_data_filters**](docs/DataFiltersApi.md#search_entities_user_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/search | The search endpoint (beta) +*DataFiltersApi* | [**search_entities_workspace_data_filter_settings**](docs/DataFiltersApi.md#search_entities_workspace_data_filter_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/search | The search endpoint (beta) +*DataFiltersApi* | [**search_entities_workspace_data_filters**](docs/DataFiltersApi.md#search_entities_workspace_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/search | The search endpoint (beta) *DataFiltersApi* | [**set_workspace_data_filters_layout**](docs/DataFiltersApi.md#set_workspace_data_filters_layout) | **PUT** /api/v1/layout/workspaceDataFilters | Set all workspace data filters *DataFiltersApi* | [**update_entity_user_data_filters**](docs/DataFiltersApi.md#update_entity_user_data_filters) | **PUT** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Put a User Data Filter *DataFiltersApi* | [**update_entity_workspace_data_filter_settings**](docs/DataFiltersApi.md#update_entity_workspace_data_filter_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Put a Settings for Workspace Data Filter @@ -232,7 +233,7 @@ Class | Method | HTTP request | Description *DatasetsApi* | [**get_all_entities_datasets**](docs/DatasetsApi.md#get_all_entities_datasets) | **GET** /api/v1/entities/workspaces/{workspaceId}/datasets | Get all Datasets *DatasetsApi* | [**get_entity_datasets**](docs/DatasetsApi.md#get_entity_datasets) | **GET** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Get a Dataset *DatasetsApi* | [**patch_entity_datasets**](docs/DatasetsApi.md#patch_entity_datasets) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Patch a Dataset (beta) -*DatasetsApi* | [**search_entities_datasets**](docs/DatasetsApi.md#search_entities_datasets) | **POST** /api/v1/entities/workspaces/{workspaceId}/datasets/search | Search request for Dataset +*DatasetsApi* | [**search_entities_datasets**](docs/DatasetsApi.md#search_entities_datasets) | **POST** /api/v1/entities/workspaces/{workspaceId}/datasets/search | The search endpoint (beta) *DependencyGraphApi* | [**get_dependent_entities_graph**](docs/DependencyGraphApi.md#get_dependent_entities_graph) | **GET** /api/v1/actions/workspaces/{workspaceId}/dependentEntitiesGraph | Computes the dependent entities graph *DependencyGraphApi* | [**get_dependent_entities_graph_from_entry_points**](docs/DependencyGraphApi.md#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**](docs/EntitlementApi.md#get_all_entities_entitlements) | **GET** /api/v1/entities/entitlements | Get Entitlements @@ -244,7 +245,7 @@ Class | Method | HTTP request | Description *ExportDefinitionsApi* | [**get_all_entities_export_definitions**](docs/ExportDefinitionsApi.md#get_all_entities_export_definitions) | **GET** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions | Get all Export Definitions *ExportDefinitionsApi* | [**get_entity_export_definitions**](docs/ExportDefinitionsApi.md#get_entity_export_definitions) | **GET** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Get an Export Definition *ExportDefinitionsApi* | [**patch_entity_export_definitions**](docs/ExportDefinitionsApi.md#patch_entity_export_definitions) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Patch an Export Definition -*ExportDefinitionsApi* | [**search_entities_export_definitions**](docs/ExportDefinitionsApi.md#search_entities_export_definitions) | **POST** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/search | Search request for ExportDefinition +*ExportDefinitionsApi* | [**search_entities_export_definitions**](docs/ExportDefinitionsApi.md#search_entities_export_definitions) | **POST** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/search | The search endpoint (beta) *ExportDefinitionsApi* | [**update_entity_export_definitions**](docs/ExportDefinitionsApi.md#update_entity_export_definitions) | **PUT** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Put an Export Definition *ExportTemplatesApi* | [**create_entity_export_templates**](docs/ExportTemplatesApi.md#create_entity_export_templates) | **POST** /api/v1/entities/exportTemplates | Post Export Template entities *ExportTemplatesApi* | [**delete_entity_export_templates**](docs/ExportTemplatesApi.md#delete_entity_export_templates) | **DELETE** /api/v1/entities/exportTemplates/{id} | Delete Export Template entity @@ -258,13 +259,13 @@ Class | Method | HTTP request | Description *FactsApi* | [**get_entity_facts**](docs/FactsApi.md#get_entity_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/facts/{objectId} | Get a Fact *FactsApi* | [**patch_entity_facts**](docs/FactsApi.md#patch_entity_facts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/facts/{objectId} | Patch a Fact (beta) *FactsApi* | [**search_entities_aggregated_facts**](docs/FactsApi.md#search_entities_aggregated_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/search | Search request for AggregatedFact -*FactsApi* | [**search_entities_facts**](docs/FactsApi.md#search_entities_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/facts/search | Search request for Fact +*FactsApi* | [**search_entities_facts**](docs/FactsApi.md#search_entities_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/facts/search | The search endpoint (beta) *FilterContextApi* | [**create_entity_filter_contexts**](docs/FilterContextApi.md#create_entity_filter_contexts) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterContexts | Post Filter Context *FilterContextApi* | [**delete_entity_filter_contexts**](docs/FilterContextApi.md#delete_entity_filter_contexts) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Delete a Filter Context *FilterContextApi* | [**get_all_entities_filter_contexts**](docs/FilterContextApi.md#get_all_entities_filter_contexts) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterContexts | Get all Filter Context *FilterContextApi* | [**get_entity_filter_contexts**](docs/FilterContextApi.md#get_entity_filter_contexts) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Get a Filter Context *FilterContextApi* | [**patch_entity_filter_contexts**](docs/FilterContextApi.md#patch_entity_filter_contexts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Patch a Filter Context -*FilterContextApi* | [**search_entities_filter_contexts**](docs/FilterContextApi.md#search_entities_filter_contexts) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterContexts/search | Search request for FilterContext +*FilterContextApi* | [**search_entities_filter_contexts**](docs/FilterContextApi.md#search_entities_filter_contexts) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterContexts/search | The search endpoint (beta) *FilterContextApi* | [**update_entity_filter_contexts**](docs/FilterContextApi.md#update_entity_filter_contexts) | **PUT** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Put a Filter Context *FilterViewsApi* | [**create_entity_filter_views**](docs/FilterViewsApi.md#create_entity_filter_views) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterViews | Post Filter views *FilterViewsApi* | [**delete_entity_filter_views**](docs/FilterViewsApi.md#delete_entity_filter_views) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Delete Filter view @@ -272,17 +273,17 @@ Class | Method | HTTP request | Description *FilterViewsApi* | [**get_entity_filter_views**](docs/FilterViewsApi.md#get_entity_filter_views) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Get Filter view *FilterViewsApi* | [**get_filter_views**](docs/FilterViewsApi.md#get_filter_views) | **GET** /api/v1/layout/workspaces/{workspaceId}/filterViews | Get filter views *FilterViewsApi* | [**patch_entity_filter_views**](docs/FilterViewsApi.md#patch_entity_filter_views) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Patch Filter view -*FilterViewsApi* | [**search_entities_filter_views**](docs/FilterViewsApi.md#search_entities_filter_views) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterViews/search | Search request for FilterView +*FilterViewsApi* | [**search_entities_filter_views**](docs/FilterViewsApi.md#search_entities_filter_views) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterViews/search | The search endpoint (beta) *FilterViewsApi* | [**set_filter_views**](docs/FilterViewsApi.md#set_filter_views) | **PUT** /api/v1/layout/workspaces/{workspaceId}/filterViews | Set filter views *FilterViewsApi* | [**update_entity_filter_views**](docs/FilterViewsApi.md#update_entity_filter_views) | **PUT** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Put Filter views *GenerateLogicalDataModelApi* | [**generate_logical_model**](docs/GenerateLogicalDataModelApi.md#generate_logical_model) | **POST** /api/v1/actions/dataSources/{dataSourceId}/generateLogicalModel | Generate logical data model (LDM) from physical data model (PDM) *GenerateLogicalDataModelApi* | [**generate_logical_model_aac**](docs/GenerateLogicalDataModelApi.md#generate_logical_model_aac) | **POST** /api/v1/actions/dataSources/{dataSourceId}/generateLogicalModelAac | Generate logical data model in AAC format from physical data model (PDM) -*GeographicDataApi* | [**create_entity_custom_geo_collections**](docs/GeographicDataApi.md#create_entity_custom_geo_collections) | **POST** /api/v1/entities/customGeoCollections | -*GeographicDataApi* | [**delete_entity_custom_geo_collections**](docs/GeographicDataApi.md#delete_entity_custom_geo_collections) | **DELETE** /api/v1/entities/customGeoCollections/{id} | -*GeographicDataApi* | [**get_all_entities_custom_geo_collections**](docs/GeographicDataApi.md#get_all_entities_custom_geo_collections) | **GET** /api/v1/entities/customGeoCollections | -*GeographicDataApi* | [**get_entity_custom_geo_collections**](docs/GeographicDataApi.md#get_entity_custom_geo_collections) | **GET** /api/v1/entities/customGeoCollections/{id} | -*GeographicDataApi* | [**patch_entity_custom_geo_collections**](docs/GeographicDataApi.md#patch_entity_custom_geo_collections) | **PATCH** /api/v1/entities/customGeoCollections/{id} | -*GeographicDataApi* | [**update_entity_custom_geo_collections**](docs/GeographicDataApi.md#update_entity_custom_geo_collections) | **PUT** /api/v1/entities/customGeoCollections/{id} | +*GeographicDataApi* | [**create_entity_custom_geo_collections**](docs/GeographicDataApi.md#create_entity_custom_geo_collections) | **POST** /api/v1/entities/customGeoCollections | Post Custom Geo Collections +*GeographicDataApi* | [**delete_entity_custom_geo_collections**](docs/GeographicDataApi.md#delete_entity_custom_geo_collections) | **DELETE** /api/v1/entities/customGeoCollections/{id} | Delete Custom Geo Collection +*GeographicDataApi* | [**get_all_entities_custom_geo_collections**](docs/GeographicDataApi.md#get_all_entities_custom_geo_collections) | **GET** /api/v1/entities/customGeoCollections | Get all Custom Geo Collections +*GeographicDataApi* | [**get_entity_custom_geo_collections**](docs/GeographicDataApi.md#get_entity_custom_geo_collections) | **GET** /api/v1/entities/customGeoCollections/{id} | Get Custom Geo Collection +*GeographicDataApi* | [**patch_entity_custom_geo_collections**](docs/GeographicDataApi.md#patch_entity_custom_geo_collections) | **PATCH** /api/v1/entities/customGeoCollections/{id} | Patch Custom Geo Collection +*GeographicDataApi* | [**update_entity_custom_geo_collections**](docs/GeographicDataApi.md#update_entity_custom_geo_collections) | **PUT** /api/v1/entities/customGeoCollections/{id} | Put Custom Geo Collection *HierarchyApi* | [**check_entity_overrides**](docs/HierarchyApi.md#check_entity_overrides) | **POST** /api/v1/actions/workspaces/{workspaceId}/checkEntityOverrides | Finds entities with given ID in hierarchy. *HierarchyApi* | [**inherited_entity_conflicts**](docs/HierarchyApi.md#inherited_entity_conflicts) | **GET** /api/v1/actions/workspaces/{workspaceId}/inheritedEntityConflicts | Finds identifier conflicts in workspace hierarchy. *HierarchyApi* | [**inherited_entity_prefixes**](docs/HierarchyApi.md#inherited_entity_prefixes) | **GET** /api/v1/actions/workspaces/{workspaceId}/inheritedEntityPrefixes | Get used entity prefixes in hierarchy @@ -322,7 +323,7 @@ Class | Method | HTTP request | Description *LabelsApi* | [**get_all_entities_labels**](docs/LabelsApi.md#get_all_entities_labels) | **GET** /api/v1/entities/workspaces/{workspaceId}/labels | Get all Labels *LabelsApi* | [**get_entity_labels**](docs/LabelsApi.md#get_entity_labels) | **GET** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Get a Label *LabelsApi* | [**patch_entity_labels**](docs/LabelsApi.md#patch_entity_labels) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Patch a Label (beta) -*LabelsApi* | [**search_entities_labels**](docs/LabelsApi.md#search_entities_labels) | **POST** /api/v1/entities/workspaces/{workspaceId}/labels/search | Search request for Label +*LabelsApi* | [**search_entities_labels**](docs/LabelsApi.md#search_entities_labels) | **POST** /api/v1/entities/workspaces/{workspaceId}/labels/search | The search endpoint (beta) *ManagePermissionsApi* | [**get_data_source_permissions**](docs/ManagePermissionsApi.md#get_data_source_permissions) | **GET** /api/v1/layout/dataSources/{dataSourceId}/permissions | Get permissions for the data source *ManagePermissionsApi* | [**manage_data_source_permissions**](docs/ManagePermissionsApi.md#manage_data_source_permissions) | **POST** /api/v1/actions/dataSources/{dataSourceId}/managePermissions | Manage Permissions for a Data Source *ManagePermissionsApi* | [**set_data_source_permissions**](docs/ManagePermissionsApi.md#set_data_source_permissions) | **PUT** /api/v1/layout/dataSources/{dataSourceId}/permissions | Set data source permissions. @@ -334,7 +335,7 @@ Class | Method | HTTP request | Description *MetricsApi* | [**get_all_entities_metrics**](docs/MetricsApi.md#get_all_entities_metrics) | **GET** /api/v1/entities/workspaces/{workspaceId}/metrics | Get all Metrics *MetricsApi* | [**get_entity_metrics**](docs/MetricsApi.md#get_entity_metrics) | **GET** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Get a Metric *MetricsApi* | [**patch_entity_metrics**](docs/MetricsApi.md#patch_entity_metrics) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Patch a Metric -*MetricsApi* | [**search_entities_metrics**](docs/MetricsApi.md#search_entities_metrics) | **POST** /api/v1/entities/workspaces/{workspaceId}/metrics/search | Search request for Metric +*MetricsApi* | [**search_entities_metrics**](docs/MetricsApi.md#search_entities_metrics) | **POST** /api/v1/entities/workspaces/{workspaceId}/metrics/search | The search endpoint (beta) *MetricsApi* | [**update_entity_metrics**](docs/MetricsApi.md#update_entity_metrics) | **PUT** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Put a Metric *NotificationChannelsApi* | [**create_entity_notification_channels**](docs/NotificationChannelsApi.md#create_entity_notification_channels) | **POST** /api/v1/entities/notificationChannels | Post Notification Channel entities *NotificationChannelsApi* | [**delete_entity_notification_channels**](docs/NotificationChannelsApi.md#delete_entity_notification_channels) | **DELETE** /api/v1/entities/notificationChannels/{id} | Delete Notification Channel entity @@ -388,7 +389,7 @@ Class | Method | HTTP request | Description *PluginsApi* | [**get_all_entities_dashboard_plugins**](docs/PluginsApi.md#get_all_entities_dashboard_plugins) | **GET** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins | Get all Plugins *PluginsApi* | [**get_entity_dashboard_plugins**](docs/PluginsApi.md#get_entity_dashboard_plugins) | **GET** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Get a Plugin *PluginsApi* | [**patch_entity_dashboard_plugins**](docs/PluginsApi.md#patch_entity_dashboard_plugins) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Patch a Plugin -*PluginsApi* | [**search_entities_dashboard_plugins**](docs/PluginsApi.md#search_entities_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search | Search request for DashboardPlugin +*PluginsApi* | [**search_entities_dashboard_plugins**](docs/PluginsApi.md#search_entities_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search | The search endpoint (beta) *PluginsApi* | [**update_entity_dashboard_plugins**](docs/PluginsApi.md#update_entity_dashboard_plugins) | **PUT** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Put a Plugin *RawExportApi* | [**create_raw_export**](docs/RawExportApi.md#create_raw_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/raw | (EXPERIMENTAL) Create raw export request *RawExportApi* | [**get_raw_export**](docs/RawExportApi.md#get_raw_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/raw/{exportId} | (EXPERIMENTAL) Retrieve exported files @@ -416,11 +417,14 @@ Class | Method | HTTP request | Description *SmartFunctionsApi* | [**generate_title**](docs/SmartFunctionsApi.md#generate_title) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/generateTitle | Generate Title for Analytics Object *SmartFunctionsApi* | [**get_quality_issues**](docs/SmartFunctionsApi.md#get_quality_issues) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/issues | Get Quality Issues *SmartFunctionsApi* | [**get_quality_issues_calculation_status**](docs/SmartFunctionsApi.md#get_quality_issues_calculation_status) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/issues/status/{processId} | Get Quality Issues Calculation Status +*SmartFunctionsApi* | [**list_llm_provider_models**](docs/SmartFunctionsApi.md#list_llm_provider_models) | **POST** /api/v1/actions/ai/llmProvider/listModels | List LLM Provider Models +*SmartFunctionsApi* | [**list_llm_provider_models_by_id**](docs/SmartFunctionsApi.md#list_llm_provider_models_by_id) | **POST** /api/v1/actions/ai/llmProvider/{llmProviderId}/listModels | List LLM Provider Models By Id *SmartFunctionsApi* | [**memory_created_by_users**](docs/SmartFunctionsApi.md#memory_created_by_users) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/memory/createdBy | Get AI Memory CreatedBy Users *SmartFunctionsApi* | [**resolve_llm_endpoints**](docs/SmartFunctionsApi.md#resolve_llm_endpoints) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmEndpoints | Get Active LLM Endpoints for this workspace *SmartFunctionsApi* | [**tags**](docs/SmartFunctionsApi.md#tags) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/tags | Get Analytics Catalog Tags *SmartFunctionsApi* | [**test_llm_provider**](docs/SmartFunctionsApi.md#test_llm_provider) | **POST** /api/v1/actions/ai/llmProvider/test | Test LLM Provider *SmartFunctionsApi* | [**test_llm_provider_by_id**](docs/SmartFunctionsApi.md#test_llm_provider_by_id) | **POST** /api/v1/actions/ai/llmProvider/{llmProviderId}/test | Test LLM Provider By Id +*SmartFunctionsApi* | [**trending_objects**](docs/SmartFunctionsApi.md#trending_objects) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/trendingObjects | Get Trending Analytics Catalog Objects *SmartFunctionsApi* | [**trigger_quality_issues_calculation**](docs/SmartFunctionsApi.md#trigger_quality_issues_calculation) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/issues/triggerCheck | Trigger Quality Issues Calculation *SmartFunctionsApi* | [**validate_llm_endpoint**](docs/SmartFunctionsApi.md#validate_llm_endpoint) | **POST** /api/v1/actions/ai/llmEndpoint/test | Validate LLM Endpoint *SmartFunctionsApi* | [**validate_llm_endpoint_by_id**](docs/SmartFunctionsApi.md#validate_llm_endpoint_by_id) | **POST** /api/v1/actions/ai/llmEndpoint/{llmEndpointId}/test | Validate LLM Endpoint By Id @@ -484,7 +488,7 @@ Class | Method | HTTP request | Description *VisualizationObjectApi* | [**get_all_entities_visualization_objects**](docs/VisualizationObjectApi.md#get_all_entities_visualization_objects) | **GET** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects | Get all Visualization Objects *VisualizationObjectApi* | [**get_entity_visualization_objects**](docs/VisualizationObjectApi.md#get_entity_visualization_objects) | **GET** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Get a Visualization Object *VisualizationObjectApi* | [**patch_entity_visualization_objects**](docs/VisualizationObjectApi.md#patch_entity_visualization_objects) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Patch a Visualization Object -*VisualizationObjectApi* | [**search_entities_visualization_objects**](docs/VisualizationObjectApi.md#search_entities_visualization_objects) | **POST** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/search | Search request for VisualizationObject +*VisualizationObjectApi* | [**search_entities_visualization_objects**](docs/VisualizationObjectApi.md#search_entities_visualization_objects) | **POST** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/search | The search endpoint (beta) *VisualizationObjectApi* | [**update_entity_visualization_objects**](docs/VisualizationObjectApi.md#update_entity_visualization_objects) | **PUT** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Put a Visualization Object *WorkspacesDeclarativeAPIsApi* | [**get_workspace_layout**](docs/WorkspacesDeclarativeAPIsApi.md#get_workspace_layout) | **GET** /api/v1/layout/workspaces/{workspaceId} | Get workspace layout *WorkspacesDeclarativeAPIsApi* | [**get_workspaces_layout**](docs/WorkspacesDeclarativeAPIsApi.md#get_workspaces_layout) | **GET** /api/v1/layout/workspaces | Get all workspaces layout @@ -506,8 +510,8 @@ Class | Method | HTTP request | Description *WorkspacesSettingsApi* | [**get_entity_workspace_settings**](docs/WorkspacesSettingsApi.md#get_entity_workspace_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Get a Setting for Workspace *WorkspacesSettingsApi* | [**patch_entity_custom_application_settings**](docs/WorkspacesSettingsApi.md#patch_entity_custom_application_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Patch a Custom Application Setting *WorkspacesSettingsApi* | [**patch_entity_workspace_settings**](docs/WorkspacesSettingsApi.md#patch_entity_workspace_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Patch a Setting for Workspace -*WorkspacesSettingsApi* | [**search_entities_custom_application_settings**](docs/WorkspacesSettingsApi.md#search_entities_custom_application_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search | Search request for CustomApplicationSetting -*WorkspacesSettingsApi* | [**search_entities_workspace_settings**](docs/WorkspacesSettingsApi.md#search_entities_workspace_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/search | +*WorkspacesSettingsApi* | [**search_entities_custom_application_settings**](docs/WorkspacesSettingsApi.md#search_entities_custom_application_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search | The search endpoint (beta) +*WorkspacesSettingsApi* | [**search_entities_workspace_settings**](docs/WorkspacesSettingsApi.md#search_entities_workspace_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/search | The search endpoint (beta) *WorkspacesSettingsApi* | [**update_entity_custom_application_settings**](docs/WorkspacesSettingsApi.md#update_entity_custom_application_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Put a Custom Application Setting *WorkspacesSettingsApi* | [**update_entity_workspace_settings**](docs/WorkspacesSettingsApi.md#update_entity_workspace_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Put a Setting for a Workspace *WorkspacesSettingsApi* | [**workspace_resolve_all_settings**](docs/WorkspacesSettingsApi.md#workspace_resolve_all_settings) | **GET** /api/v1/actions/workspaces/{workspaceId}/resolveSettings | Values for all settings. @@ -577,6 +581,8 @@ Class | Method | HTTP request | Description *ActionsApi* | [**key_driver_analysis**](docs/ActionsApi.md#key_driver_analysis) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers | (EXPERIMENTAL) Compute key driver analysis *ActionsApi* | [**key_driver_analysis_result**](docs/ActionsApi.md#key_driver_analysis_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers/result/{resultId} | (EXPERIMENTAL) Get key driver analysis result *ActionsApi* | [**list_documents**](docs/ActionsApi.md#list_documents) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/knowledge/documents | +*ActionsApi* | [**list_llm_provider_models**](docs/ActionsApi.md#list_llm_provider_models) | **POST** /api/v1/actions/ai/llmProvider/listModels | List LLM Provider Models +*ActionsApi* | [**list_llm_provider_models_by_id**](docs/ActionsApi.md#list_llm_provider_models_by_id) | **POST** /api/v1/actions/ai/llmProvider/{llmProviderId}/listModels | List LLM Provider Models By Id *ActionsApi* | [**list_workspace_user_groups**](docs/ActionsApi.md#list_workspace_user_groups) | **GET** /api/v1/actions/workspaces/{workspaceId}/userGroups | *ActionsApi* | [**list_workspace_users**](docs/ActionsApi.md#list_workspace_users) | **GET** /api/v1/actions/workspaces/{workspaceId}/users | *ActionsApi* | [**manage_dashboard_permissions**](docs/ActionsApi.md#manage_dashboard_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/managePermissions | Manage Permissions for a Dashboard @@ -618,6 +624,7 @@ Class | Method | HTTP request | Description *ActionsApi* | [**test_llm_provider**](docs/ActionsApi.md#test_llm_provider) | **POST** /api/v1/actions/ai/llmProvider/test | Test LLM Provider *ActionsApi* | [**test_llm_provider_by_id**](docs/ActionsApi.md#test_llm_provider_by_id) | **POST** /api/v1/actions/ai/llmProvider/{llmProviderId}/test | Test LLM Provider By Id *ActionsApi* | [**test_notification_channel**](docs/ActionsApi.md#test_notification_channel) | **POST** /api/v1/actions/notificationChannels/test | Test notification channel. +*ActionsApi* | [**trending_objects**](docs/ActionsApi.md#trending_objects) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/trendingObjects | Get Trending Analytics Catalog Objects *ActionsApi* | [**trigger_automation**](docs/ActionsApi.md#trigger_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/trigger | Trigger automation. *ActionsApi* | [**trigger_existing_automation**](docs/ActionsApi.md#trigger_existing_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/trigger | Trigger existing automation. *ActionsApi* | [**trigger_quality_issues_calculation**](docs/ActionsApi.md#trigger_quality_issues_calculation) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/issues/triggerCheck | Trigger Quality Issues Calculation @@ -633,7 +640,69 @@ Class | Method | HTTP request | Description *ActionsApi* | [**validate_llm_endpoint_by_id**](docs/ActionsApi.md#validate_llm_endpoint_by_id) | **POST** /api/v1/actions/ai/llmEndpoint/{llmEndpointId}/test | Validate LLM Endpoint By Id *ActionsApi* | [**workspace_resolve_all_settings**](docs/ActionsApi.md#workspace_resolve_all_settings) | **GET** /api/v1/actions/workspaces/{workspaceId}/resolveSettings | Values for all settings. *ActionsApi* | [**workspace_resolve_settings**](docs/ActionsApi.md#workspace_resolve_settings) | **POST** /api/v1/actions/workspaces/{workspaceId}/resolveSettings | Values for selected settings. +*AnalyticalDashboardControllerApi* | [**create_entity_analytical_dashboards**](docs/AnalyticalDashboardControllerApi.md#create_entity_analytical_dashboards) | **POST** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards | Post Dashboards +*AnalyticalDashboardControllerApi* | [**delete_entity_analytical_dashboards**](docs/AnalyticalDashboardControllerApi.md#delete_entity_analytical_dashboards) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Delete a Dashboard +*AnalyticalDashboardControllerApi* | [**get_all_entities_analytical_dashboards**](docs/AnalyticalDashboardControllerApi.md#get_all_entities_analytical_dashboards) | **GET** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards | Get all Dashboards +*AnalyticalDashboardControllerApi* | [**get_entity_analytical_dashboards**](docs/AnalyticalDashboardControllerApi.md#get_entity_analytical_dashboards) | **GET** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Get a Dashboard +*AnalyticalDashboardControllerApi* | [**patch_entity_analytical_dashboards**](docs/AnalyticalDashboardControllerApi.md#patch_entity_analytical_dashboards) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Patch a Dashboard +*AnalyticalDashboardControllerApi* | [**search_entities_analytical_dashboards**](docs/AnalyticalDashboardControllerApi.md#search_entities_analytical_dashboards) | **POST** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search | The search endpoint (beta) +*AnalyticalDashboardControllerApi* | [**update_entity_analytical_dashboards**](docs/AnalyticalDashboardControllerApi.md#update_entity_analytical_dashboards) | **PUT** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Put Dashboards +*ApiTokenControllerApi* | [**create_entity_api_tokens**](docs/ApiTokenControllerApi.md#create_entity_api_tokens) | **POST** /api/v1/entities/users/{userId}/apiTokens | Post a new API token for the user +*ApiTokenControllerApi* | [**delete_entity_api_tokens**](docs/ApiTokenControllerApi.md#delete_entity_api_tokens) | **DELETE** /api/v1/entities/users/{userId}/apiTokens/{id} | Delete an API Token for a user +*ApiTokenControllerApi* | [**get_all_entities_api_tokens**](docs/ApiTokenControllerApi.md#get_all_entities_api_tokens) | **GET** /api/v1/entities/users/{userId}/apiTokens | List all api tokens for a user +*ApiTokenControllerApi* | [**get_entity_api_tokens**](docs/ApiTokenControllerApi.md#get_entity_api_tokens) | **GET** /api/v1/entities/users/{userId}/apiTokens/{id} | Get an API Token for a user +*AttributeControllerApi* | [**get_all_entities_attributes**](docs/AttributeControllerApi.md#get_all_entities_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributes | Get all Attributes +*AttributeControllerApi* | [**get_entity_attributes**](docs/AttributeControllerApi.md#get_entity_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId} | Get an Attribute +*AttributeControllerApi* | [**patch_entity_attributes**](docs/AttributeControllerApi.md#patch_entity_attributes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId} | Patch an Attribute (beta) +*AttributeControllerApi* | [**search_entities_attributes**](docs/AttributeControllerApi.md#search_entities_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributes/search | The search endpoint (beta) +*AttributeHierarchyControllerApi* | [**create_entity_attribute_hierarchies**](docs/AttributeHierarchyControllerApi.md#create_entity_attribute_hierarchies) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies | Post Attribute Hierarchies +*AttributeHierarchyControllerApi* | [**delete_entity_attribute_hierarchies**](docs/AttributeHierarchyControllerApi.md#delete_entity_attribute_hierarchies) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Delete an Attribute Hierarchy +*AttributeHierarchyControllerApi* | [**get_all_entities_attribute_hierarchies**](docs/AttributeHierarchyControllerApi.md#get_all_entities_attribute_hierarchies) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies | Get all Attribute Hierarchies +*AttributeHierarchyControllerApi* | [**get_entity_attribute_hierarchies**](docs/AttributeHierarchyControllerApi.md#get_entity_attribute_hierarchies) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Get an Attribute Hierarchy +*AttributeHierarchyControllerApi* | [**patch_entity_attribute_hierarchies**](docs/AttributeHierarchyControllerApi.md#patch_entity_attribute_hierarchies) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Patch an Attribute Hierarchy +*AttributeHierarchyControllerApi* | [**search_entities_attribute_hierarchies**](docs/AttributeHierarchyControllerApi.md#search_entities_attribute_hierarchies) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search | The search endpoint (beta) +*AttributeHierarchyControllerApi* | [**update_entity_attribute_hierarchies**](docs/AttributeHierarchyControllerApi.md#update_entity_attribute_hierarchies) | **PUT** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Put an Attribute Hierarchy +*AutomationControllerApi* | [**create_entity_automations**](docs/AutomationControllerApi.md#create_entity_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations | Post Automations +*AutomationControllerApi* | [**delete_entity_automations**](docs/AutomationControllerApi.md#delete_entity_automations) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Delete an Automation +*AutomationControllerApi* | [**get_all_entities_automations**](docs/AutomationControllerApi.md#get_all_entities_automations) | **GET** /api/v1/entities/workspaces/{workspaceId}/automations | Get all Automations +*AutomationControllerApi* | [**get_entity_automations**](docs/AutomationControllerApi.md#get_entity_automations) | **GET** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Get an Automation +*AutomationControllerApi* | [**patch_entity_automations**](docs/AutomationControllerApi.md#patch_entity_automations) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Patch an Automation +*AutomationControllerApi* | [**search_entities_automations**](docs/AutomationControllerApi.md#search_entities_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations/search | The search endpoint (beta) +*AutomationControllerApi* | [**update_entity_automations**](docs/AutomationControllerApi.md#update_entity_automations) | **PUT** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Put an Automation *AutomationOrganizationViewControllerApi* | [**get_all_automations_workspace_automations**](docs/AutomationOrganizationViewControllerApi.md#get_all_automations_workspace_automations) | **GET** /api/v1/entities/organization/workspaceAutomations | Get all Automations across all Workspaces +*CookieSecurityConfigurationControllerApi* | [**get_entity_cookie_security_configurations**](docs/CookieSecurityConfigurationControllerApi.md#get_entity_cookie_security_configurations) | **GET** /api/v1/entities/admin/cookieSecurityConfigurations/{id} | Get CookieSecurityConfiguration +*CookieSecurityConfigurationControllerApi* | [**patch_entity_cookie_security_configurations**](docs/CookieSecurityConfigurationControllerApi.md#patch_entity_cookie_security_configurations) | **PATCH** /api/v1/entities/admin/cookieSecurityConfigurations/{id} | Patch CookieSecurityConfiguration +*CookieSecurityConfigurationControllerApi* | [**update_entity_cookie_security_configurations**](docs/CookieSecurityConfigurationControllerApi.md#update_entity_cookie_security_configurations) | **PUT** /api/v1/entities/admin/cookieSecurityConfigurations/{id} | Put CookieSecurityConfiguration +*CustomApplicationSettingControllerApi* | [**create_entity_custom_application_settings**](docs/CustomApplicationSettingControllerApi.md#create_entity_custom_application_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings | Post Custom Application Settings +*CustomApplicationSettingControllerApi* | [**delete_entity_custom_application_settings**](docs/CustomApplicationSettingControllerApi.md#delete_entity_custom_application_settings) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Delete a Custom Application Setting +*CustomApplicationSettingControllerApi* | [**get_all_entities_custom_application_settings**](docs/CustomApplicationSettingControllerApi.md#get_all_entities_custom_application_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings | Get all Custom Application Settings +*CustomApplicationSettingControllerApi* | [**get_entity_custom_application_settings**](docs/CustomApplicationSettingControllerApi.md#get_entity_custom_application_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Get a Custom Application Setting +*CustomApplicationSettingControllerApi* | [**patch_entity_custom_application_settings**](docs/CustomApplicationSettingControllerApi.md#patch_entity_custom_application_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Patch a Custom Application Setting +*CustomApplicationSettingControllerApi* | [**search_entities_custom_application_settings**](docs/CustomApplicationSettingControllerApi.md#search_entities_custom_application_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search | The search endpoint (beta) +*CustomApplicationSettingControllerApi* | [**update_entity_custom_application_settings**](docs/CustomApplicationSettingControllerApi.md#update_entity_custom_application_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Put a Custom Application Setting +*CustomGeoCollectionControllerApi* | [**create_entity_custom_geo_collections**](docs/CustomGeoCollectionControllerApi.md#create_entity_custom_geo_collections) | **POST** /api/v1/entities/customGeoCollections | Post Custom Geo Collections +*CustomGeoCollectionControllerApi* | [**delete_entity_custom_geo_collections**](docs/CustomGeoCollectionControllerApi.md#delete_entity_custom_geo_collections) | **DELETE** /api/v1/entities/customGeoCollections/{id} | Delete Custom Geo Collection +*CustomGeoCollectionControllerApi* | [**get_all_entities_custom_geo_collections**](docs/CustomGeoCollectionControllerApi.md#get_all_entities_custom_geo_collections) | **GET** /api/v1/entities/customGeoCollections | Get all Custom Geo Collections +*CustomGeoCollectionControllerApi* | [**get_entity_custom_geo_collections**](docs/CustomGeoCollectionControllerApi.md#get_entity_custom_geo_collections) | **GET** /api/v1/entities/customGeoCollections/{id} | Get Custom Geo Collection +*CustomGeoCollectionControllerApi* | [**patch_entity_custom_geo_collections**](docs/CustomGeoCollectionControllerApi.md#patch_entity_custom_geo_collections) | **PATCH** /api/v1/entities/customGeoCollections/{id} | Patch Custom Geo Collection +*CustomGeoCollectionControllerApi* | [**update_entity_custom_geo_collections**](docs/CustomGeoCollectionControllerApi.md#update_entity_custom_geo_collections) | **PUT** /api/v1/entities/customGeoCollections/{id} | Put Custom Geo Collection +*DashboardPluginControllerApi* | [**create_entity_dashboard_plugins**](docs/DashboardPluginControllerApi.md#create_entity_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins | Post Plugins +*DashboardPluginControllerApi* | [**delete_entity_dashboard_plugins**](docs/DashboardPluginControllerApi.md#delete_entity_dashboard_plugins) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Delete a Plugin +*DashboardPluginControllerApi* | [**get_all_entities_dashboard_plugins**](docs/DashboardPluginControllerApi.md#get_all_entities_dashboard_plugins) | **GET** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins | Get all Plugins +*DashboardPluginControllerApi* | [**get_entity_dashboard_plugins**](docs/DashboardPluginControllerApi.md#get_entity_dashboard_plugins) | **GET** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Get a Plugin +*DashboardPluginControllerApi* | [**patch_entity_dashboard_plugins**](docs/DashboardPluginControllerApi.md#patch_entity_dashboard_plugins) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Patch a Plugin +*DashboardPluginControllerApi* | [**search_entities_dashboard_plugins**](docs/DashboardPluginControllerApi.md#search_entities_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search | The search endpoint (beta) +*DashboardPluginControllerApi* | [**update_entity_dashboard_plugins**](docs/DashboardPluginControllerApi.md#update_entity_dashboard_plugins) | **PUT** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Put a Plugin +*DataSourceControllerApi* | [**create_entity_data_sources**](docs/DataSourceControllerApi.md#create_entity_data_sources) | **POST** /api/v1/entities/dataSources | Post Data Sources +*DataSourceControllerApi* | [**delete_entity_data_sources**](docs/DataSourceControllerApi.md#delete_entity_data_sources) | **DELETE** /api/v1/entities/dataSources/{id} | Delete Data Source entity +*DataSourceControllerApi* | [**get_all_entities_data_sources**](docs/DataSourceControllerApi.md#get_all_entities_data_sources) | **GET** /api/v1/entities/dataSources | Get Data Source entities +*DataSourceControllerApi* | [**get_entity_data_sources**](docs/DataSourceControllerApi.md#get_entity_data_sources) | **GET** /api/v1/entities/dataSources/{id} | Get Data Source entity +*DataSourceControllerApi* | [**patch_entity_data_sources**](docs/DataSourceControllerApi.md#patch_entity_data_sources) | **PATCH** /api/v1/entities/dataSources/{id} | Patch Data Source entity +*DataSourceControllerApi* | [**update_entity_data_sources**](docs/DataSourceControllerApi.md#update_entity_data_sources) | **PUT** /api/v1/entities/dataSources/{id} | Put Data Source entity +*DatasetControllerApi* | [**get_all_entities_datasets**](docs/DatasetControllerApi.md#get_all_entities_datasets) | **GET** /api/v1/entities/workspaces/{workspaceId}/datasets | Get all Datasets +*DatasetControllerApi* | [**get_entity_datasets**](docs/DatasetControllerApi.md#get_entity_datasets) | **GET** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Get a Dataset +*DatasetControllerApi* | [**patch_entity_datasets**](docs/DatasetControllerApi.md#patch_entity_datasets) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Patch a Dataset (beta) +*DatasetControllerApi* | [**search_entities_datasets**](docs/DatasetControllerApi.md#search_entities_datasets) | **POST** /api/v1/entities/workspaces/{workspaceId}/datasets/search | The search endpoint (beta) *EntitiesApi* | [**create_entity_analytical_dashboards**](docs/EntitiesApi.md#create_entity_analytical_dashboards) | **POST** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards | Post Dashboards *EntitiesApi* | [**create_entity_api_tokens**](docs/EntitiesApi.md#create_entity_api_tokens) | **POST** /api/v1/entities/users/{userId}/apiTokens | Post a new API token for the user *EntitiesApi* | [**create_entity_attribute_hierarchies**](docs/EntitiesApi.md#create_entity_attribute_hierarchies) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies | Post Attribute Hierarchies @@ -641,7 +710,7 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**create_entity_color_palettes**](docs/EntitiesApi.md#create_entity_color_palettes) | **POST** /api/v1/entities/colorPalettes | Post Color Pallettes *EntitiesApi* | [**create_entity_csp_directives**](docs/EntitiesApi.md#create_entity_csp_directives) | **POST** /api/v1/entities/cspDirectives | Post CSP Directives *EntitiesApi* | [**create_entity_custom_application_settings**](docs/EntitiesApi.md#create_entity_custom_application_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings | Post Custom Application Settings -*EntitiesApi* | [**create_entity_custom_geo_collections**](docs/EntitiesApi.md#create_entity_custom_geo_collections) | **POST** /api/v1/entities/customGeoCollections | +*EntitiesApi* | [**create_entity_custom_geo_collections**](docs/EntitiesApi.md#create_entity_custom_geo_collections) | **POST** /api/v1/entities/customGeoCollections | Post Custom Geo Collections *EntitiesApi* | [**create_entity_dashboard_plugins**](docs/EntitiesApi.md#create_entity_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins | Post Plugins *EntitiesApi* | [**create_entity_data_sources**](docs/EntitiesApi.md#create_entity_data_sources) | **POST** /api/v1/entities/dataSources | Post Data Sources *EntitiesApi* | [**create_entity_export_definitions**](docs/EntitiesApi.md#create_entity_export_definitions) | **POST** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions | Post Export Definitions @@ -674,7 +743,7 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**delete_entity_color_palettes**](docs/EntitiesApi.md#delete_entity_color_palettes) | **DELETE** /api/v1/entities/colorPalettes/{id} | Delete a Color Pallette *EntitiesApi* | [**delete_entity_csp_directives**](docs/EntitiesApi.md#delete_entity_csp_directives) | **DELETE** /api/v1/entities/cspDirectives/{id} | Delete CSP Directives *EntitiesApi* | [**delete_entity_custom_application_settings**](docs/EntitiesApi.md#delete_entity_custom_application_settings) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Delete a Custom Application Setting -*EntitiesApi* | [**delete_entity_custom_geo_collections**](docs/EntitiesApi.md#delete_entity_custom_geo_collections) | **DELETE** /api/v1/entities/customGeoCollections/{id} | +*EntitiesApi* | [**delete_entity_custom_geo_collections**](docs/EntitiesApi.md#delete_entity_custom_geo_collections) | **DELETE** /api/v1/entities/customGeoCollections/{id} | Delete Custom Geo Collection *EntitiesApi* | [**delete_entity_dashboard_plugins**](docs/EntitiesApi.md#delete_entity_dashboard_plugins) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Delete a Plugin *EntitiesApi* | [**delete_entity_data_sources**](docs/EntitiesApi.md#delete_entity_data_sources) | **DELETE** /api/v1/entities/dataSources/{id} | Delete Data Source entity *EntitiesApi* | [**delete_entity_export_definitions**](docs/EntitiesApi.md#delete_entity_export_definitions) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Delete an Export Definition @@ -710,7 +779,7 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**get_all_entities_color_palettes**](docs/EntitiesApi.md#get_all_entities_color_palettes) | **GET** /api/v1/entities/colorPalettes | Get all Color Pallettes *EntitiesApi* | [**get_all_entities_csp_directives**](docs/EntitiesApi.md#get_all_entities_csp_directives) | **GET** /api/v1/entities/cspDirectives | Get CSP Directives *EntitiesApi* | [**get_all_entities_custom_application_settings**](docs/EntitiesApi.md#get_all_entities_custom_application_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings | Get all Custom Application Settings -*EntitiesApi* | [**get_all_entities_custom_geo_collections**](docs/EntitiesApi.md#get_all_entities_custom_geo_collections) | **GET** /api/v1/entities/customGeoCollections | +*EntitiesApi* | [**get_all_entities_custom_geo_collections**](docs/EntitiesApi.md#get_all_entities_custom_geo_collections) | **GET** /api/v1/entities/customGeoCollections | Get all Custom Geo Collections *EntitiesApi* | [**get_all_entities_dashboard_plugins**](docs/EntitiesApi.md#get_all_entities_dashboard_plugins) | **GET** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins | Get all Plugins *EntitiesApi* | [**get_all_entities_data_source_identifiers**](docs/EntitiesApi.md#get_all_entities_data_source_identifiers) | **GET** /api/v1/entities/dataSourceIdentifiers | Get all Data Source Identifiers *EntitiesApi* | [**get_all_entities_data_sources**](docs/EntitiesApi.md#get_all_entities_data_sources) | **GET** /api/v1/entities/dataSources | Get Data Source entities @@ -755,7 +824,7 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**get_entity_cookie_security_configurations**](docs/EntitiesApi.md#get_entity_cookie_security_configurations) | **GET** /api/v1/entities/admin/cookieSecurityConfigurations/{id} | Get CookieSecurityConfiguration *EntitiesApi* | [**get_entity_csp_directives**](docs/EntitiesApi.md#get_entity_csp_directives) | **GET** /api/v1/entities/cspDirectives/{id} | Get CSP Directives *EntitiesApi* | [**get_entity_custom_application_settings**](docs/EntitiesApi.md#get_entity_custom_application_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Get a Custom Application Setting -*EntitiesApi* | [**get_entity_custom_geo_collections**](docs/EntitiesApi.md#get_entity_custom_geo_collections) | **GET** /api/v1/entities/customGeoCollections/{id} | +*EntitiesApi* | [**get_entity_custom_geo_collections**](docs/EntitiesApi.md#get_entity_custom_geo_collections) | **GET** /api/v1/entities/customGeoCollections/{id} | Get Custom Geo Collection *EntitiesApi* | [**get_entity_dashboard_plugins**](docs/EntitiesApi.md#get_entity_dashboard_plugins) | **GET** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Get a Plugin *EntitiesApi* | [**get_entity_data_source_identifiers**](docs/EntitiesApi.md#get_entity_data_source_identifiers) | **GET** /api/v1/entities/dataSourceIdentifiers/{id} | Get Data Source Identifier *EntitiesApi* | [**get_entity_data_sources**](docs/EntitiesApi.md#get_entity_data_sources) | **GET** /api/v1/entities/dataSources/{id} | Get Data Source entity @@ -798,7 +867,7 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**patch_entity_cookie_security_configurations**](docs/EntitiesApi.md#patch_entity_cookie_security_configurations) | **PATCH** /api/v1/entities/admin/cookieSecurityConfigurations/{id} | Patch CookieSecurityConfiguration *EntitiesApi* | [**patch_entity_csp_directives**](docs/EntitiesApi.md#patch_entity_csp_directives) | **PATCH** /api/v1/entities/cspDirectives/{id} | Patch CSP Directives *EntitiesApi* | [**patch_entity_custom_application_settings**](docs/EntitiesApi.md#patch_entity_custom_application_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Patch a Custom Application Setting -*EntitiesApi* | [**patch_entity_custom_geo_collections**](docs/EntitiesApi.md#patch_entity_custom_geo_collections) | **PATCH** /api/v1/entities/customGeoCollections/{id} | +*EntitiesApi* | [**patch_entity_custom_geo_collections**](docs/EntitiesApi.md#patch_entity_custom_geo_collections) | **PATCH** /api/v1/entities/customGeoCollections/{id} | Patch Custom Geo Collection *EntitiesApi* | [**patch_entity_dashboard_plugins**](docs/EntitiesApi.md#patch_entity_dashboard_plugins) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Patch a Plugin *EntitiesApi* | [**patch_entity_data_sources**](docs/EntitiesApi.md#patch_entity_data_sources) | **PATCH** /api/v1/entities/dataSources/{id} | Patch Data Source entity *EntitiesApi* | [**patch_entity_datasets**](docs/EntitiesApi.md#patch_entity_datasets) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Patch a Dataset (beta) @@ -828,27 +897,27 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**patch_entity_workspace_settings**](docs/EntitiesApi.md#patch_entity_workspace_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Patch a Setting for Workspace *EntitiesApi* | [**patch_entity_workspaces**](docs/EntitiesApi.md#patch_entity_workspaces) | **PATCH** /api/v1/entities/workspaces/{id} | Patch Workspace entity *EntitiesApi* | [**search_entities_aggregated_facts**](docs/EntitiesApi.md#search_entities_aggregated_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/search | Search request for AggregatedFact -*EntitiesApi* | [**search_entities_analytical_dashboards**](docs/EntitiesApi.md#search_entities_analytical_dashboards) | **POST** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search | Search request for AnalyticalDashboard -*EntitiesApi* | [**search_entities_attribute_hierarchies**](docs/EntitiesApi.md#search_entities_attribute_hierarchies) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search | Search request for AttributeHierarchy -*EntitiesApi* | [**search_entities_attributes**](docs/EntitiesApi.md#search_entities_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributes/search | Search request for Attribute +*EntitiesApi* | [**search_entities_analytical_dashboards**](docs/EntitiesApi.md#search_entities_analytical_dashboards) | **POST** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search | The search endpoint (beta) +*EntitiesApi* | [**search_entities_attribute_hierarchies**](docs/EntitiesApi.md#search_entities_attribute_hierarchies) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search | The search endpoint (beta) +*EntitiesApi* | [**search_entities_attributes**](docs/EntitiesApi.md#search_entities_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributes/search | The search endpoint (beta) *EntitiesApi* | [**search_entities_automation_results**](docs/EntitiesApi.md#search_entities_automation_results) | **POST** /api/v1/entities/workspaces/{workspaceId}/automationResults/search | Search request for AutomationResult -*EntitiesApi* | [**search_entities_automations**](docs/EntitiesApi.md#search_entities_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations/search | Search request for Automation -*EntitiesApi* | [**search_entities_custom_application_settings**](docs/EntitiesApi.md#search_entities_custom_application_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search | Search request for CustomApplicationSetting -*EntitiesApi* | [**search_entities_dashboard_plugins**](docs/EntitiesApi.md#search_entities_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search | Search request for DashboardPlugin -*EntitiesApi* | [**search_entities_datasets**](docs/EntitiesApi.md#search_entities_datasets) | **POST** /api/v1/entities/workspaces/{workspaceId}/datasets/search | Search request for Dataset -*EntitiesApi* | [**search_entities_export_definitions**](docs/EntitiesApi.md#search_entities_export_definitions) | **POST** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/search | Search request for ExportDefinition -*EntitiesApi* | [**search_entities_facts**](docs/EntitiesApi.md#search_entities_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/facts/search | Search request for Fact -*EntitiesApi* | [**search_entities_filter_contexts**](docs/EntitiesApi.md#search_entities_filter_contexts) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterContexts/search | Search request for FilterContext -*EntitiesApi* | [**search_entities_filter_views**](docs/EntitiesApi.md#search_entities_filter_views) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterViews/search | Search request for FilterView -*EntitiesApi* | [**search_entities_knowledge_recommendations**](docs/EntitiesApi.md#search_entities_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search | -*EntitiesApi* | [**search_entities_labels**](docs/EntitiesApi.md#search_entities_labels) | **POST** /api/v1/entities/workspaces/{workspaceId}/labels/search | Search request for Label +*EntitiesApi* | [**search_entities_automations**](docs/EntitiesApi.md#search_entities_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations/search | The search endpoint (beta) +*EntitiesApi* | [**search_entities_custom_application_settings**](docs/EntitiesApi.md#search_entities_custom_application_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search | The search endpoint (beta) +*EntitiesApi* | [**search_entities_dashboard_plugins**](docs/EntitiesApi.md#search_entities_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search | The search endpoint (beta) +*EntitiesApi* | [**search_entities_datasets**](docs/EntitiesApi.md#search_entities_datasets) | **POST** /api/v1/entities/workspaces/{workspaceId}/datasets/search | The search endpoint (beta) +*EntitiesApi* | [**search_entities_export_definitions**](docs/EntitiesApi.md#search_entities_export_definitions) | **POST** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/search | The search endpoint (beta) +*EntitiesApi* | [**search_entities_facts**](docs/EntitiesApi.md#search_entities_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/facts/search | The search endpoint (beta) +*EntitiesApi* | [**search_entities_filter_contexts**](docs/EntitiesApi.md#search_entities_filter_contexts) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterContexts/search | The search endpoint (beta) +*EntitiesApi* | [**search_entities_filter_views**](docs/EntitiesApi.md#search_entities_filter_views) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterViews/search | The search endpoint (beta) +*EntitiesApi* | [**search_entities_knowledge_recommendations**](docs/EntitiesApi.md#search_entities_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search | The search endpoint (beta) +*EntitiesApi* | [**search_entities_labels**](docs/EntitiesApi.md#search_entities_labels) | **POST** /api/v1/entities/workspaces/{workspaceId}/labels/search | The search endpoint (beta) *EntitiesApi* | [**search_entities_memory_items**](docs/EntitiesApi.md#search_entities_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems/search | Search request for MemoryItem -*EntitiesApi* | [**search_entities_metrics**](docs/EntitiesApi.md#search_entities_metrics) | **POST** /api/v1/entities/workspaces/{workspaceId}/metrics/search | Search request for Metric -*EntitiesApi* | [**search_entities_user_data_filters**](docs/EntitiesApi.md#search_entities_user_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/search | Search request for UserDataFilter -*EntitiesApi* | [**search_entities_visualization_objects**](docs/EntitiesApi.md#search_entities_visualization_objects) | **POST** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/search | Search request for VisualizationObject -*EntitiesApi* | [**search_entities_workspace_data_filter_settings**](docs/EntitiesApi.md#search_entities_workspace_data_filter_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/search | Search request for WorkspaceDataFilterSetting -*EntitiesApi* | [**search_entities_workspace_data_filters**](docs/EntitiesApi.md#search_entities_workspace_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/search | Search request for WorkspaceDataFilter -*EntitiesApi* | [**search_entities_workspace_settings**](docs/EntitiesApi.md#search_entities_workspace_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/search | +*EntitiesApi* | [**search_entities_metrics**](docs/EntitiesApi.md#search_entities_metrics) | **POST** /api/v1/entities/workspaces/{workspaceId}/metrics/search | The search endpoint (beta) +*EntitiesApi* | [**search_entities_user_data_filters**](docs/EntitiesApi.md#search_entities_user_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/search | The search endpoint (beta) +*EntitiesApi* | [**search_entities_visualization_objects**](docs/EntitiesApi.md#search_entities_visualization_objects) | **POST** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/search | The search endpoint (beta) +*EntitiesApi* | [**search_entities_workspace_data_filter_settings**](docs/EntitiesApi.md#search_entities_workspace_data_filter_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/search | The search endpoint (beta) +*EntitiesApi* | [**search_entities_workspace_data_filters**](docs/EntitiesApi.md#search_entities_workspace_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/search | The search endpoint (beta) +*EntitiesApi* | [**search_entities_workspace_settings**](docs/EntitiesApi.md#search_entities_workspace_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/search | The search endpoint (beta) *EntitiesApi* | [**update_entity_analytical_dashboards**](docs/EntitiesApi.md#update_entity_analytical_dashboards) | **PUT** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Put Dashboards *EntitiesApi* | [**update_entity_attribute_hierarchies**](docs/EntitiesApi.md#update_entity_attribute_hierarchies) | **PUT** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Put an Attribute Hierarchy *EntitiesApi* | [**update_entity_automations**](docs/EntitiesApi.md#update_entity_automations) | **PUT** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Put an Automation @@ -856,7 +925,7 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**update_entity_cookie_security_configurations**](docs/EntitiesApi.md#update_entity_cookie_security_configurations) | **PUT** /api/v1/entities/admin/cookieSecurityConfigurations/{id} | Put CookieSecurityConfiguration *EntitiesApi* | [**update_entity_csp_directives**](docs/EntitiesApi.md#update_entity_csp_directives) | **PUT** /api/v1/entities/cspDirectives/{id} | Put CSP Directives *EntitiesApi* | [**update_entity_custom_application_settings**](docs/EntitiesApi.md#update_entity_custom_application_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Put a Custom Application Setting -*EntitiesApi* | [**update_entity_custom_geo_collections**](docs/EntitiesApi.md#update_entity_custom_geo_collections) | **PUT** /api/v1/entities/customGeoCollections/{id} | +*EntitiesApi* | [**update_entity_custom_geo_collections**](docs/EntitiesApi.md#update_entity_custom_geo_collections) | **PUT** /api/v1/entities/customGeoCollections/{id} | Put Custom Geo Collection *EntitiesApi* | [**update_entity_dashboard_plugins**](docs/EntitiesApi.md#update_entity_dashboard_plugins) | **PUT** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Put a Plugin *EntitiesApi* | [**update_entity_data_sources**](docs/EntitiesApi.md#update_entity_data_sources) | **PUT** /api/v1/entities/dataSources/{id} | Put Data Source entity *EntitiesApi* | [**update_entity_export_definitions**](docs/EntitiesApi.md#update_entity_export_definitions) | **PUT** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Put an Export Definition @@ -883,6 +952,41 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**update_entity_workspace_data_filters**](docs/EntitiesApi.md#update_entity_workspace_data_filters) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Put a Workspace Data Filter *EntitiesApi* | [**update_entity_workspace_settings**](docs/EntitiesApi.md#update_entity_workspace_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Put a Setting for a Workspace *EntitiesApi* | [**update_entity_workspaces**](docs/EntitiesApi.md#update_entity_workspaces) | **PUT** /api/v1/entities/workspaces/{id} | Put Workspace entity +*ExportDefinitionControllerApi* | [**create_entity_export_definitions**](docs/ExportDefinitionControllerApi.md#create_entity_export_definitions) | **POST** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions | Post Export Definitions +*ExportDefinitionControllerApi* | [**delete_entity_export_definitions**](docs/ExportDefinitionControllerApi.md#delete_entity_export_definitions) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Delete an Export Definition +*ExportDefinitionControllerApi* | [**get_all_entities_export_definitions**](docs/ExportDefinitionControllerApi.md#get_all_entities_export_definitions) | **GET** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions | Get all Export Definitions +*ExportDefinitionControllerApi* | [**get_entity_export_definitions**](docs/ExportDefinitionControllerApi.md#get_entity_export_definitions) | **GET** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Get an Export Definition +*ExportDefinitionControllerApi* | [**patch_entity_export_definitions**](docs/ExportDefinitionControllerApi.md#patch_entity_export_definitions) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Patch an Export Definition +*ExportDefinitionControllerApi* | [**search_entities_export_definitions**](docs/ExportDefinitionControllerApi.md#search_entities_export_definitions) | **POST** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/search | The search endpoint (beta) +*ExportDefinitionControllerApi* | [**update_entity_export_definitions**](docs/ExportDefinitionControllerApi.md#update_entity_export_definitions) | **PUT** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Put an Export Definition +*FactControllerApi* | [**get_all_entities_facts**](docs/FactControllerApi.md#get_all_entities_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/facts | Get all Facts +*FactControllerApi* | [**get_entity_facts**](docs/FactControllerApi.md#get_entity_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/facts/{objectId} | Get a Fact +*FactControllerApi* | [**patch_entity_facts**](docs/FactControllerApi.md#patch_entity_facts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/facts/{objectId} | Patch a Fact (beta) +*FactControllerApi* | [**search_entities_facts**](docs/FactControllerApi.md#search_entities_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/facts/search | The search endpoint (beta) +*FilterContextControllerApi* | [**create_entity_filter_contexts**](docs/FilterContextControllerApi.md#create_entity_filter_contexts) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterContexts | Post Filter Context +*FilterContextControllerApi* | [**delete_entity_filter_contexts**](docs/FilterContextControllerApi.md#delete_entity_filter_contexts) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Delete a Filter Context +*FilterContextControllerApi* | [**get_all_entities_filter_contexts**](docs/FilterContextControllerApi.md#get_all_entities_filter_contexts) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterContexts | Get all Filter Context +*FilterContextControllerApi* | [**get_entity_filter_contexts**](docs/FilterContextControllerApi.md#get_entity_filter_contexts) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Get a Filter Context +*FilterContextControllerApi* | [**patch_entity_filter_contexts**](docs/FilterContextControllerApi.md#patch_entity_filter_contexts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Patch a Filter Context +*FilterContextControllerApi* | [**search_entities_filter_contexts**](docs/FilterContextControllerApi.md#search_entities_filter_contexts) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterContexts/search | The search endpoint (beta) +*FilterContextControllerApi* | [**update_entity_filter_contexts**](docs/FilterContextControllerApi.md#update_entity_filter_contexts) | **PUT** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Put a Filter Context +*FilterViewControllerApi* | [**create_entity_filter_views**](docs/FilterViewControllerApi.md#create_entity_filter_views) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterViews | Post Filter views +*FilterViewControllerApi* | [**delete_entity_filter_views**](docs/FilterViewControllerApi.md#delete_entity_filter_views) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Delete Filter view +*FilterViewControllerApi* | [**get_all_entities_filter_views**](docs/FilterViewControllerApi.md#get_all_entities_filter_views) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterViews | Get all Filter views +*FilterViewControllerApi* | [**get_entity_filter_views**](docs/FilterViewControllerApi.md#get_entity_filter_views) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Get Filter view +*FilterViewControllerApi* | [**patch_entity_filter_views**](docs/FilterViewControllerApi.md#patch_entity_filter_views) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Patch Filter view +*FilterViewControllerApi* | [**search_entities_filter_views**](docs/FilterViewControllerApi.md#search_entities_filter_views) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterViews/search | The search endpoint (beta) +*FilterViewControllerApi* | [**update_entity_filter_views**](docs/FilterViewControllerApi.md#update_entity_filter_views) | **PUT** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Put Filter views +*JwkControllerApi* | [**create_entity_jwks**](docs/JwkControllerApi.md#create_entity_jwks) | **POST** /api/v1/entities/jwks | Post Jwks +*JwkControllerApi* | [**delete_entity_jwks**](docs/JwkControllerApi.md#delete_entity_jwks) | **DELETE** /api/v1/entities/jwks/{id} | Delete Jwk +*JwkControllerApi* | [**get_all_entities_jwks**](docs/JwkControllerApi.md#get_all_entities_jwks) | **GET** /api/v1/entities/jwks | Get all Jwks +*JwkControllerApi* | [**get_entity_jwks**](docs/JwkControllerApi.md#get_entity_jwks) | **GET** /api/v1/entities/jwks/{id} | Get Jwk +*JwkControllerApi* | [**patch_entity_jwks**](docs/JwkControllerApi.md#patch_entity_jwks) | **PATCH** /api/v1/entities/jwks/{id} | Patch Jwk +*JwkControllerApi* | [**update_entity_jwks**](docs/JwkControllerApi.md#update_entity_jwks) | **PUT** /api/v1/entities/jwks/{id} | Put Jwk +*LabelControllerApi* | [**get_all_entities_labels**](docs/LabelControllerApi.md#get_all_entities_labels) | **GET** /api/v1/entities/workspaces/{workspaceId}/labels | Get all Labels +*LabelControllerApi* | [**get_entity_labels**](docs/LabelControllerApi.md#get_entity_labels) | **GET** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Get a Label +*LabelControllerApi* | [**patch_entity_labels**](docs/LabelControllerApi.md#patch_entity_labels) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Patch a Label (beta) +*LabelControllerApi* | [**search_entities_labels**](docs/LabelControllerApi.md#search_entities_labels) | **POST** /api/v1/entities/workspaces/{workspaceId}/labels/search | The search endpoint (beta) *LayoutApi* | [**get_analytics_model**](docs/LayoutApi.md#get_analytics_model) | **GET** /api/v1/layout/workspaces/{workspaceId}/analyticsModel | Get analytics model *LayoutApi* | [**get_automations**](docs/LayoutApi.md#get_automations) | **GET** /api/v1/layout/workspaces/{workspaceId}/automations | Get automations *LayoutApi* | [**get_custom_geo_collections_layout**](docs/LayoutApi.md#get_custom_geo_collections_layout) | **GET** /api/v1/layout/customGeoCollections | Get all custom geo collections layout @@ -927,19 +1031,20 @@ Class | Method | HTTP request | Description *LayoutApi* | [**set_workspace_data_filters_layout**](docs/LayoutApi.md#set_workspace_data_filters_layout) | **PUT** /api/v1/layout/workspaceDataFilters | Set all workspace data filters *LayoutApi* | [**set_workspace_permissions**](docs/LayoutApi.md#set_workspace_permissions) | **PUT** /api/v1/layout/workspaces/{workspaceId}/permissions | Set permissions for the workspace *LayoutApi* | [**set_workspaces_layout**](docs/LayoutApi.md#set_workspaces_layout) | **PUT** /api/v1/layout/workspaces | Set all workspaces layout -*OrganizationControllerApi* | [**get_entity_cookie_security_configurations**](docs/OrganizationControllerApi.md#get_entity_cookie_security_configurations) | **GET** /api/v1/entities/admin/cookieSecurityConfigurations/{id} | Get CookieSecurityConfiguration -*OrganizationControllerApi* | [**get_entity_organizations**](docs/OrganizationControllerApi.md#get_entity_organizations) | **GET** /api/v1/entities/admin/organizations/{id} | Get Organizations -*OrganizationControllerApi* | [**patch_entity_cookie_security_configurations**](docs/OrganizationControllerApi.md#patch_entity_cookie_security_configurations) | **PATCH** /api/v1/entities/admin/cookieSecurityConfigurations/{id} | Patch CookieSecurityConfiguration -*OrganizationControllerApi* | [**patch_entity_organizations**](docs/OrganizationControllerApi.md#patch_entity_organizations) | **PATCH** /api/v1/entities/admin/organizations/{id} | Patch Organization -*OrganizationControllerApi* | [**update_entity_cookie_security_configurations**](docs/OrganizationControllerApi.md#update_entity_cookie_security_configurations) | **PUT** /api/v1/entities/admin/cookieSecurityConfigurations/{id} | Put CookieSecurityConfiguration -*OrganizationControllerApi* | [**update_entity_organizations**](docs/OrganizationControllerApi.md#update_entity_organizations) | **PUT** /api/v1/entities/admin/organizations/{id} | Put Organization +*MetricControllerApi* | [**create_entity_metrics**](docs/MetricControllerApi.md#create_entity_metrics) | **POST** /api/v1/entities/workspaces/{workspaceId}/metrics | Post Metrics +*MetricControllerApi* | [**delete_entity_metrics**](docs/MetricControllerApi.md#delete_entity_metrics) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Delete a Metric +*MetricControllerApi* | [**get_all_entities_metrics**](docs/MetricControllerApi.md#get_all_entities_metrics) | **GET** /api/v1/entities/workspaces/{workspaceId}/metrics | Get all Metrics +*MetricControllerApi* | [**get_entity_metrics**](docs/MetricControllerApi.md#get_entity_metrics) | **GET** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Get a Metric +*MetricControllerApi* | [**patch_entity_metrics**](docs/MetricControllerApi.md#patch_entity_metrics) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Patch a Metric +*MetricControllerApi* | [**search_entities_metrics**](docs/MetricControllerApi.md#search_entities_metrics) | **POST** /api/v1/entities/workspaces/{workspaceId}/metrics/search | The search endpoint (beta) +*MetricControllerApi* | [**update_entity_metrics**](docs/MetricControllerApi.md#update_entity_metrics) | **PUT** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Put a Metric +*OrganizationEntityControllerApi* | [**get_entity_organizations**](docs/OrganizationEntityControllerApi.md#get_entity_organizations) | **GET** /api/v1/entities/admin/organizations/{id} | Get Organizations +*OrganizationEntityControllerApi* | [**patch_entity_organizations**](docs/OrganizationEntityControllerApi.md#patch_entity_organizations) | **PATCH** /api/v1/entities/admin/organizations/{id} | Patch Organization +*OrganizationEntityControllerApi* | [**update_entity_organizations**](docs/OrganizationEntityControllerApi.md#update_entity_organizations) | **PUT** /api/v1/entities/admin/organizations/{id} | Put Organization *OrganizationModelControllerApi* | [**create_entity_color_palettes**](docs/OrganizationModelControllerApi.md#create_entity_color_palettes) | **POST** /api/v1/entities/colorPalettes | Post Color Pallettes *OrganizationModelControllerApi* | [**create_entity_csp_directives**](docs/OrganizationModelControllerApi.md#create_entity_csp_directives) | **POST** /api/v1/entities/cspDirectives | Post CSP Directives -*OrganizationModelControllerApi* | [**create_entity_custom_geo_collections**](docs/OrganizationModelControllerApi.md#create_entity_custom_geo_collections) | **POST** /api/v1/entities/customGeoCollections | -*OrganizationModelControllerApi* | [**create_entity_data_sources**](docs/OrganizationModelControllerApi.md#create_entity_data_sources) | **POST** /api/v1/entities/dataSources | Post Data Sources *OrganizationModelControllerApi* | [**create_entity_export_templates**](docs/OrganizationModelControllerApi.md#create_entity_export_templates) | **POST** /api/v1/entities/exportTemplates | Post Export Template entities *OrganizationModelControllerApi* | [**create_entity_identity_providers**](docs/OrganizationModelControllerApi.md#create_entity_identity_providers) | **POST** /api/v1/entities/identityProviders | Post Identity Providers -*OrganizationModelControllerApi* | [**create_entity_jwks**](docs/OrganizationModelControllerApi.md#create_entity_jwks) | **POST** /api/v1/entities/jwks | Post Jwks *OrganizationModelControllerApi* | [**create_entity_llm_endpoints**](docs/OrganizationModelControllerApi.md#create_entity_llm_endpoints) | **POST** /api/v1/entities/llmEndpoints | Post LLM endpoint entities *OrganizationModelControllerApi* | [**create_entity_llm_providers**](docs/OrganizationModelControllerApi.md#create_entity_llm_providers) | **POST** /api/v1/entities/llmProviders | Post LLM Provider entities *OrganizationModelControllerApi* | [**create_entity_notification_channels**](docs/OrganizationModelControllerApi.md#create_entity_notification_channels) | **POST** /api/v1/entities/notificationChannels | Post Notification Channel entities @@ -950,11 +1055,8 @@ Class | Method | HTTP request | Description *OrganizationModelControllerApi* | [**create_entity_workspaces**](docs/OrganizationModelControllerApi.md#create_entity_workspaces) | **POST** /api/v1/entities/workspaces | Post Workspace entities *OrganizationModelControllerApi* | [**delete_entity_color_palettes**](docs/OrganizationModelControllerApi.md#delete_entity_color_palettes) | **DELETE** /api/v1/entities/colorPalettes/{id} | Delete a Color Pallette *OrganizationModelControllerApi* | [**delete_entity_csp_directives**](docs/OrganizationModelControllerApi.md#delete_entity_csp_directives) | **DELETE** /api/v1/entities/cspDirectives/{id} | Delete CSP Directives -*OrganizationModelControllerApi* | [**delete_entity_custom_geo_collections**](docs/OrganizationModelControllerApi.md#delete_entity_custom_geo_collections) | **DELETE** /api/v1/entities/customGeoCollections/{id} | -*OrganizationModelControllerApi* | [**delete_entity_data_sources**](docs/OrganizationModelControllerApi.md#delete_entity_data_sources) | **DELETE** /api/v1/entities/dataSources/{id} | Delete Data Source entity *OrganizationModelControllerApi* | [**delete_entity_export_templates**](docs/OrganizationModelControllerApi.md#delete_entity_export_templates) | **DELETE** /api/v1/entities/exportTemplates/{id} | Delete Export Template entity *OrganizationModelControllerApi* | [**delete_entity_identity_providers**](docs/OrganizationModelControllerApi.md#delete_entity_identity_providers) | **DELETE** /api/v1/entities/identityProviders/{id} | Delete Identity Provider -*OrganizationModelControllerApi* | [**delete_entity_jwks**](docs/OrganizationModelControllerApi.md#delete_entity_jwks) | **DELETE** /api/v1/entities/jwks/{id} | Delete Jwk *OrganizationModelControllerApi* | [**delete_entity_llm_endpoints**](docs/OrganizationModelControllerApi.md#delete_entity_llm_endpoints) | **DELETE** /api/v1/entities/llmEndpoints/{id} | *OrganizationModelControllerApi* | [**delete_entity_llm_providers**](docs/OrganizationModelControllerApi.md#delete_entity_llm_providers) | **DELETE** /api/v1/entities/llmProviders/{id} | Delete LLM Provider entity *OrganizationModelControllerApi* | [**delete_entity_notification_channels**](docs/OrganizationModelControllerApi.md#delete_entity_notification_channels) | **DELETE** /api/v1/entities/notificationChannels/{id} | Delete Notification Channel entity @@ -965,13 +1067,10 @@ Class | Method | HTTP request | Description *OrganizationModelControllerApi* | [**delete_entity_workspaces**](docs/OrganizationModelControllerApi.md#delete_entity_workspaces) | **DELETE** /api/v1/entities/workspaces/{id} | Delete Workspace entity *OrganizationModelControllerApi* | [**get_all_entities_color_palettes**](docs/OrganizationModelControllerApi.md#get_all_entities_color_palettes) | **GET** /api/v1/entities/colorPalettes | Get all Color Pallettes *OrganizationModelControllerApi* | [**get_all_entities_csp_directives**](docs/OrganizationModelControllerApi.md#get_all_entities_csp_directives) | **GET** /api/v1/entities/cspDirectives | Get CSP Directives -*OrganizationModelControllerApi* | [**get_all_entities_custom_geo_collections**](docs/OrganizationModelControllerApi.md#get_all_entities_custom_geo_collections) | **GET** /api/v1/entities/customGeoCollections | *OrganizationModelControllerApi* | [**get_all_entities_data_source_identifiers**](docs/OrganizationModelControllerApi.md#get_all_entities_data_source_identifiers) | **GET** /api/v1/entities/dataSourceIdentifiers | Get all Data Source Identifiers -*OrganizationModelControllerApi* | [**get_all_entities_data_sources**](docs/OrganizationModelControllerApi.md#get_all_entities_data_sources) | **GET** /api/v1/entities/dataSources | Get Data Source entities *OrganizationModelControllerApi* | [**get_all_entities_entitlements**](docs/OrganizationModelControllerApi.md#get_all_entities_entitlements) | **GET** /api/v1/entities/entitlements | Get Entitlements *OrganizationModelControllerApi* | [**get_all_entities_export_templates**](docs/OrganizationModelControllerApi.md#get_all_entities_export_templates) | **GET** /api/v1/entities/exportTemplates | GET all Export Template entities *OrganizationModelControllerApi* | [**get_all_entities_identity_providers**](docs/OrganizationModelControllerApi.md#get_all_entities_identity_providers) | **GET** /api/v1/entities/identityProviders | Get all Identity Providers -*OrganizationModelControllerApi* | [**get_all_entities_jwks**](docs/OrganizationModelControllerApi.md#get_all_entities_jwks) | **GET** /api/v1/entities/jwks | Get all Jwks *OrganizationModelControllerApi* | [**get_all_entities_llm_endpoints**](docs/OrganizationModelControllerApi.md#get_all_entities_llm_endpoints) | **GET** /api/v1/entities/llmEndpoints | Get all LLM endpoint entities *OrganizationModelControllerApi* | [**get_all_entities_llm_providers**](docs/OrganizationModelControllerApi.md#get_all_entities_llm_providers) | **GET** /api/v1/entities/llmProviders | Get all LLM Provider entities *OrganizationModelControllerApi* | [**get_all_entities_notification_channel_identifiers**](docs/OrganizationModelControllerApi.md#get_all_entities_notification_channel_identifiers) | **GET** /api/v1/entities/notificationChannelIdentifiers | @@ -984,13 +1083,10 @@ Class | Method | HTTP request | Description *OrganizationModelControllerApi* | [**get_all_entities_workspaces**](docs/OrganizationModelControllerApi.md#get_all_entities_workspaces) | **GET** /api/v1/entities/workspaces | Get Workspace entities *OrganizationModelControllerApi* | [**get_entity_color_palettes**](docs/OrganizationModelControllerApi.md#get_entity_color_palettes) | **GET** /api/v1/entities/colorPalettes/{id} | Get Color Pallette *OrganizationModelControllerApi* | [**get_entity_csp_directives**](docs/OrganizationModelControllerApi.md#get_entity_csp_directives) | **GET** /api/v1/entities/cspDirectives/{id} | Get CSP Directives -*OrganizationModelControllerApi* | [**get_entity_custom_geo_collections**](docs/OrganizationModelControllerApi.md#get_entity_custom_geo_collections) | **GET** /api/v1/entities/customGeoCollections/{id} | *OrganizationModelControllerApi* | [**get_entity_data_source_identifiers**](docs/OrganizationModelControllerApi.md#get_entity_data_source_identifiers) | **GET** /api/v1/entities/dataSourceIdentifiers/{id} | Get Data Source Identifier -*OrganizationModelControllerApi* | [**get_entity_data_sources**](docs/OrganizationModelControllerApi.md#get_entity_data_sources) | **GET** /api/v1/entities/dataSources/{id} | Get Data Source entity *OrganizationModelControllerApi* | [**get_entity_entitlements**](docs/OrganizationModelControllerApi.md#get_entity_entitlements) | **GET** /api/v1/entities/entitlements/{id} | Get Entitlement *OrganizationModelControllerApi* | [**get_entity_export_templates**](docs/OrganizationModelControllerApi.md#get_entity_export_templates) | **GET** /api/v1/entities/exportTemplates/{id} | GET Export Template entity *OrganizationModelControllerApi* | [**get_entity_identity_providers**](docs/OrganizationModelControllerApi.md#get_entity_identity_providers) | **GET** /api/v1/entities/identityProviders/{id} | Get Identity Provider -*OrganizationModelControllerApi* | [**get_entity_jwks**](docs/OrganizationModelControllerApi.md#get_entity_jwks) | **GET** /api/v1/entities/jwks/{id} | Get Jwk *OrganizationModelControllerApi* | [**get_entity_llm_endpoints**](docs/OrganizationModelControllerApi.md#get_entity_llm_endpoints) | **GET** /api/v1/entities/llmEndpoints/{id} | Get LLM endpoint entity *OrganizationModelControllerApi* | [**get_entity_llm_providers**](docs/OrganizationModelControllerApi.md#get_entity_llm_providers) | **GET** /api/v1/entities/llmProviders/{id} | Get LLM Provider entity *OrganizationModelControllerApi* | [**get_entity_notification_channel_identifiers**](docs/OrganizationModelControllerApi.md#get_entity_notification_channel_identifiers) | **GET** /api/v1/entities/notificationChannelIdentifiers/{id} | @@ -1003,11 +1099,8 @@ Class | Method | HTTP request | Description *OrganizationModelControllerApi* | [**get_entity_workspaces**](docs/OrganizationModelControllerApi.md#get_entity_workspaces) | **GET** /api/v1/entities/workspaces/{id} | Get Workspace entity *OrganizationModelControllerApi* | [**patch_entity_color_palettes**](docs/OrganizationModelControllerApi.md#patch_entity_color_palettes) | **PATCH** /api/v1/entities/colorPalettes/{id} | Patch Color Pallette *OrganizationModelControllerApi* | [**patch_entity_csp_directives**](docs/OrganizationModelControllerApi.md#patch_entity_csp_directives) | **PATCH** /api/v1/entities/cspDirectives/{id} | Patch CSP Directives -*OrganizationModelControllerApi* | [**patch_entity_custom_geo_collections**](docs/OrganizationModelControllerApi.md#patch_entity_custom_geo_collections) | **PATCH** /api/v1/entities/customGeoCollections/{id} | -*OrganizationModelControllerApi* | [**patch_entity_data_sources**](docs/OrganizationModelControllerApi.md#patch_entity_data_sources) | **PATCH** /api/v1/entities/dataSources/{id} | Patch Data Source entity *OrganizationModelControllerApi* | [**patch_entity_export_templates**](docs/OrganizationModelControllerApi.md#patch_entity_export_templates) | **PATCH** /api/v1/entities/exportTemplates/{id} | Patch Export Template entity *OrganizationModelControllerApi* | [**patch_entity_identity_providers**](docs/OrganizationModelControllerApi.md#patch_entity_identity_providers) | **PATCH** /api/v1/entities/identityProviders/{id} | Patch Identity Provider -*OrganizationModelControllerApi* | [**patch_entity_jwks**](docs/OrganizationModelControllerApi.md#patch_entity_jwks) | **PATCH** /api/v1/entities/jwks/{id} | Patch Jwk *OrganizationModelControllerApi* | [**patch_entity_llm_endpoints**](docs/OrganizationModelControllerApi.md#patch_entity_llm_endpoints) | **PATCH** /api/v1/entities/llmEndpoints/{id} | Patch LLM endpoint entity *OrganizationModelControllerApi* | [**patch_entity_llm_providers**](docs/OrganizationModelControllerApi.md#patch_entity_llm_providers) | **PATCH** /api/v1/entities/llmProviders/{id} | Patch LLM Provider entity *OrganizationModelControllerApi* | [**patch_entity_notification_channels**](docs/OrganizationModelControllerApi.md#patch_entity_notification_channels) | **PATCH** /api/v1/entities/notificationChannels/{id} | Patch Notification Channel entity @@ -1018,11 +1111,8 @@ Class | Method | HTTP request | Description *OrganizationModelControllerApi* | [**patch_entity_workspaces**](docs/OrganizationModelControllerApi.md#patch_entity_workspaces) | **PATCH** /api/v1/entities/workspaces/{id} | Patch Workspace entity *OrganizationModelControllerApi* | [**update_entity_color_palettes**](docs/OrganizationModelControllerApi.md#update_entity_color_palettes) | **PUT** /api/v1/entities/colorPalettes/{id} | Put Color Pallette *OrganizationModelControllerApi* | [**update_entity_csp_directives**](docs/OrganizationModelControllerApi.md#update_entity_csp_directives) | **PUT** /api/v1/entities/cspDirectives/{id} | Put CSP Directives -*OrganizationModelControllerApi* | [**update_entity_custom_geo_collections**](docs/OrganizationModelControllerApi.md#update_entity_custom_geo_collections) | **PUT** /api/v1/entities/customGeoCollections/{id} | -*OrganizationModelControllerApi* | [**update_entity_data_sources**](docs/OrganizationModelControllerApi.md#update_entity_data_sources) | **PUT** /api/v1/entities/dataSources/{id} | Put Data Source entity *OrganizationModelControllerApi* | [**update_entity_export_templates**](docs/OrganizationModelControllerApi.md#update_entity_export_templates) | **PUT** /api/v1/entities/exportTemplates/{id} | PUT Export Template entity *OrganizationModelControllerApi* | [**update_entity_identity_providers**](docs/OrganizationModelControllerApi.md#update_entity_identity_providers) | **PUT** /api/v1/entities/identityProviders/{id} | Put Identity Provider -*OrganizationModelControllerApi* | [**update_entity_jwks**](docs/OrganizationModelControllerApi.md#update_entity_jwks) | **PUT** /api/v1/entities/jwks/{id} | Put Jwk *OrganizationModelControllerApi* | [**update_entity_llm_endpoints**](docs/OrganizationModelControllerApi.md#update_entity_llm_endpoints) | **PUT** /api/v1/entities/llmEndpoints/{id} | PUT LLM endpoint entity *OrganizationModelControllerApi* | [**update_entity_llm_providers**](docs/OrganizationModelControllerApi.md#update_entity_llm_providers) | **PUT** /api/v1/entities/llmProviders/{id} | PUT LLM Provider entity *OrganizationModelControllerApi* | [**update_entity_notification_channels**](docs/OrganizationModelControllerApi.md#update_entity_notification_channels) | **PUT** /api/v1/entities/notificationChannels/{id} | Put Notification Channel entity @@ -1031,147 +1121,64 @@ Class | Method | HTTP request | Description *OrganizationModelControllerApi* | [**update_entity_user_groups**](docs/OrganizationModelControllerApi.md#update_entity_user_groups) | **PUT** /api/v1/entities/userGroups/{id} | Put UserGroup entity *OrganizationModelControllerApi* | [**update_entity_users**](docs/OrganizationModelControllerApi.md#update_entity_users) | **PUT** /api/v1/entities/users/{id} | Put User entity *OrganizationModelControllerApi* | [**update_entity_workspaces**](docs/OrganizationModelControllerApi.md#update_entity_workspaces) | **PUT** /api/v1/entities/workspaces/{id} | Put Workspace entity -*UserModelControllerApi* | [**create_entity_api_tokens**](docs/UserModelControllerApi.md#create_entity_api_tokens) | **POST** /api/v1/entities/users/{userId}/apiTokens | Post a new API token for the user -*UserModelControllerApi* | [**create_entity_user_settings**](docs/UserModelControllerApi.md#create_entity_user_settings) | **POST** /api/v1/entities/users/{userId}/userSettings | Post new user settings for the user -*UserModelControllerApi* | [**delete_entity_api_tokens**](docs/UserModelControllerApi.md#delete_entity_api_tokens) | **DELETE** /api/v1/entities/users/{userId}/apiTokens/{id} | Delete an API Token for a user -*UserModelControllerApi* | [**delete_entity_user_settings**](docs/UserModelControllerApi.md#delete_entity_user_settings) | **DELETE** /api/v1/entities/users/{userId}/userSettings/{id} | Delete a setting for a user -*UserModelControllerApi* | [**get_all_entities_api_tokens**](docs/UserModelControllerApi.md#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**](docs/UserModelControllerApi.md#get_all_entities_user_settings) | **GET** /api/v1/entities/users/{userId}/userSettings | List all settings for a user -*UserModelControllerApi* | [**get_entity_api_tokens**](docs/UserModelControllerApi.md#get_entity_api_tokens) | **GET** /api/v1/entities/users/{userId}/apiTokens/{id} | Get an API Token for a user -*UserModelControllerApi* | [**get_entity_user_settings**](docs/UserModelControllerApi.md#get_entity_user_settings) | **GET** /api/v1/entities/users/{userId}/userSettings/{id} | Get a setting for a user -*UserModelControllerApi* | [**update_entity_user_settings**](docs/UserModelControllerApi.md#update_entity_user_settings) | **PUT** /api/v1/entities/users/{userId}/userSettings/{id} | Put new user settings for the user -*WorkspaceObjectControllerApi* | [**create_entity_analytical_dashboards**](docs/WorkspaceObjectControllerApi.md#create_entity_analytical_dashboards) | **POST** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards | Post Dashboards -*WorkspaceObjectControllerApi* | [**create_entity_attribute_hierarchies**](docs/WorkspaceObjectControllerApi.md#create_entity_attribute_hierarchies) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies | Post Attribute Hierarchies -*WorkspaceObjectControllerApi* | [**create_entity_automations**](docs/WorkspaceObjectControllerApi.md#create_entity_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations | Post Automations -*WorkspaceObjectControllerApi* | [**create_entity_custom_application_settings**](docs/WorkspaceObjectControllerApi.md#create_entity_custom_application_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings | Post Custom Application Settings -*WorkspaceObjectControllerApi* | [**create_entity_dashboard_plugins**](docs/WorkspaceObjectControllerApi.md#create_entity_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins | Post Plugins -*WorkspaceObjectControllerApi* | [**create_entity_export_definitions**](docs/WorkspaceObjectControllerApi.md#create_entity_export_definitions) | **POST** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions | Post Export Definitions -*WorkspaceObjectControllerApi* | [**create_entity_filter_contexts**](docs/WorkspaceObjectControllerApi.md#create_entity_filter_contexts) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterContexts | Post Filter Context -*WorkspaceObjectControllerApi* | [**create_entity_filter_views**](docs/WorkspaceObjectControllerApi.md#create_entity_filter_views) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterViews | Post Filter views +*UserDataFilterControllerApi* | [**create_entity_user_data_filters**](docs/UserDataFilterControllerApi.md#create_entity_user_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/userDataFilters | Post User Data Filters +*UserDataFilterControllerApi* | [**delete_entity_user_data_filters**](docs/UserDataFilterControllerApi.md#delete_entity_user_data_filters) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Delete a User Data Filter +*UserDataFilterControllerApi* | [**get_all_entities_user_data_filters**](docs/UserDataFilterControllerApi.md#get_all_entities_user_data_filters) | **GET** /api/v1/entities/workspaces/{workspaceId}/userDataFilters | Get all User Data Filters +*UserDataFilterControllerApi* | [**get_entity_user_data_filters**](docs/UserDataFilterControllerApi.md#get_entity_user_data_filters) | **GET** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Get a User Data Filter +*UserDataFilterControllerApi* | [**patch_entity_user_data_filters**](docs/UserDataFilterControllerApi.md#patch_entity_user_data_filters) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Patch a User Data Filter +*UserDataFilterControllerApi* | [**search_entities_user_data_filters**](docs/UserDataFilterControllerApi.md#search_entities_user_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/search | The search endpoint (beta) +*UserDataFilterControllerApi* | [**update_entity_user_data_filters**](docs/UserDataFilterControllerApi.md#update_entity_user_data_filters) | **PUT** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Put a User Data Filter +*UserSettingControllerApi* | [**create_entity_user_settings**](docs/UserSettingControllerApi.md#create_entity_user_settings) | **POST** /api/v1/entities/users/{userId}/userSettings | Post new user settings for the user +*UserSettingControllerApi* | [**delete_entity_user_settings**](docs/UserSettingControllerApi.md#delete_entity_user_settings) | **DELETE** /api/v1/entities/users/{userId}/userSettings/{id} | Delete a setting for a user +*UserSettingControllerApi* | [**get_all_entities_user_settings**](docs/UserSettingControllerApi.md#get_all_entities_user_settings) | **GET** /api/v1/entities/users/{userId}/userSettings | List all settings for a user +*UserSettingControllerApi* | [**get_entity_user_settings**](docs/UserSettingControllerApi.md#get_entity_user_settings) | **GET** /api/v1/entities/users/{userId}/userSettings/{id} | Get a setting for a user +*UserSettingControllerApi* | [**update_entity_user_settings**](docs/UserSettingControllerApi.md#update_entity_user_settings) | **PUT** /api/v1/entities/users/{userId}/userSettings/{id} | Put new user settings for the user +*VisualizationObjectControllerApi* | [**create_entity_visualization_objects**](docs/VisualizationObjectControllerApi.md#create_entity_visualization_objects) | **POST** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects | Post Visualization Objects +*VisualizationObjectControllerApi* | [**delete_entity_visualization_objects**](docs/VisualizationObjectControllerApi.md#delete_entity_visualization_objects) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Delete a Visualization Object +*VisualizationObjectControllerApi* | [**get_all_entities_visualization_objects**](docs/VisualizationObjectControllerApi.md#get_all_entities_visualization_objects) | **GET** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects | Get all Visualization Objects +*VisualizationObjectControllerApi* | [**get_entity_visualization_objects**](docs/VisualizationObjectControllerApi.md#get_entity_visualization_objects) | **GET** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Get a Visualization Object +*VisualizationObjectControllerApi* | [**patch_entity_visualization_objects**](docs/VisualizationObjectControllerApi.md#patch_entity_visualization_objects) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Patch a Visualization Object +*VisualizationObjectControllerApi* | [**search_entities_visualization_objects**](docs/VisualizationObjectControllerApi.md#search_entities_visualization_objects) | **POST** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/search | The search endpoint (beta) +*VisualizationObjectControllerApi* | [**update_entity_visualization_objects**](docs/VisualizationObjectControllerApi.md#update_entity_visualization_objects) | **PUT** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Put a Visualization Object +*WorkspaceDataFilterControllerApi* | [**create_entity_workspace_data_filters**](docs/WorkspaceDataFilterControllerApi.md#create_entity_workspace_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters | Post Workspace Data Filters +*WorkspaceDataFilterControllerApi* | [**delete_entity_workspace_data_filters**](docs/WorkspaceDataFilterControllerApi.md#delete_entity_workspace_data_filters) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Delete a Workspace Data Filter +*WorkspaceDataFilterControllerApi* | [**get_all_entities_workspace_data_filters**](docs/WorkspaceDataFilterControllerApi.md#get_all_entities_workspace_data_filters) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters | Get all Workspace Data Filters +*WorkspaceDataFilterControllerApi* | [**get_entity_workspace_data_filters**](docs/WorkspaceDataFilterControllerApi.md#get_entity_workspace_data_filters) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Get a Workspace Data Filter +*WorkspaceDataFilterControllerApi* | [**patch_entity_workspace_data_filters**](docs/WorkspaceDataFilterControllerApi.md#patch_entity_workspace_data_filters) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Patch a Workspace Data Filter +*WorkspaceDataFilterControllerApi* | [**search_entities_workspace_data_filters**](docs/WorkspaceDataFilterControllerApi.md#search_entities_workspace_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/search | The search endpoint (beta) +*WorkspaceDataFilterControllerApi* | [**update_entity_workspace_data_filters**](docs/WorkspaceDataFilterControllerApi.md#update_entity_workspace_data_filters) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Put a Workspace Data Filter +*WorkspaceDataFilterSettingControllerApi* | [**create_entity_workspace_data_filter_settings**](docs/WorkspaceDataFilterSettingControllerApi.md#create_entity_workspace_data_filter_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings | Post Settings for Workspace Data Filters +*WorkspaceDataFilterSettingControllerApi* | [**delete_entity_workspace_data_filter_settings**](docs/WorkspaceDataFilterSettingControllerApi.md#delete_entity_workspace_data_filter_settings) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Delete a Settings for Workspace Data Filter +*WorkspaceDataFilterSettingControllerApi* | [**get_all_entities_workspace_data_filter_settings**](docs/WorkspaceDataFilterSettingControllerApi.md#get_all_entities_workspace_data_filter_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings | Get all Settings for Workspace Data Filters +*WorkspaceDataFilterSettingControllerApi* | [**get_entity_workspace_data_filter_settings**](docs/WorkspaceDataFilterSettingControllerApi.md#get_entity_workspace_data_filter_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Get a Setting for Workspace Data Filter +*WorkspaceDataFilterSettingControllerApi* | [**patch_entity_workspace_data_filter_settings**](docs/WorkspaceDataFilterSettingControllerApi.md#patch_entity_workspace_data_filter_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Patch a Settings for Workspace Data Filter +*WorkspaceDataFilterSettingControllerApi* | [**search_entities_workspace_data_filter_settings**](docs/WorkspaceDataFilterSettingControllerApi.md#search_entities_workspace_data_filter_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/search | The search endpoint (beta) +*WorkspaceDataFilterSettingControllerApi* | [**update_entity_workspace_data_filter_settings**](docs/WorkspaceDataFilterSettingControllerApi.md#update_entity_workspace_data_filter_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Put a Settings for Workspace Data Filter *WorkspaceObjectControllerApi* | [**create_entity_knowledge_recommendations**](docs/WorkspaceObjectControllerApi.md#create_entity_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations | *WorkspaceObjectControllerApi* | [**create_entity_memory_items**](docs/WorkspaceObjectControllerApi.md#create_entity_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems | -*WorkspaceObjectControllerApi* | [**create_entity_metrics**](docs/WorkspaceObjectControllerApi.md#create_entity_metrics) | **POST** /api/v1/entities/workspaces/{workspaceId}/metrics | Post Metrics -*WorkspaceObjectControllerApi* | [**create_entity_user_data_filters**](docs/WorkspaceObjectControllerApi.md#create_entity_user_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/userDataFilters | Post User Data Filters -*WorkspaceObjectControllerApi* | [**create_entity_visualization_objects**](docs/WorkspaceObjectControllerApi.md#create_entity_visualization_objects) | **POST** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects | Post Visualization Objects -*WorkspaceObjectControllerApi* | [**create_entity_workspace_data_filter_settings**](docs/WorkspaceObjectControllerApi.md#create_entity_workspace_data_filter_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings | Post Settings for Workspace Data Filters -*WorkspaceObjectControllerApi* | [**create_entity_workspace_data_filters**](docs/WorkspaceObjectControllerApi.md#create_entity_workspace_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters | Post Workspace Data Filters -*WorkspaceObjectControllerApi* | [**create_entity_workspace_settings**](docs/WorkspaceObjectControllerApi.md#create_entity_workspace_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings | Post Settings for Workspaces -*WorkspaceObjectControllerApi* | [**delete_entity_analytical_dashboards**](docs/WorkspaceObjectControllerApi.md#delete_entity_analytical_dashboards) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Delete a Dashboard -*WorkspaceObjectControllerApi* | [**delete_entity_attribute_hierarchies**](docs/WorkspaceObjectControllerApi.md#delete_entity_attribute_hierarchies) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Delete an Attribute Hierarchy -*WorkspaceObjectControllerApi* | [**delete_entity_automations**](docs/WorkspaceObjectControllerApi.md#delete_entity_automations) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Delete an Automation -*WorkspaceObjectControllerApi* | [**delete_entity_custom_application_settings**](docs/WorkspaceObjectControllerApi.md#delete_entity_custom_application_settings) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Delete a Custom Application Setting -*WorkspaceObjectControllerApi* | [**delete_entity_dashboard_plugins**](docs/WorkspaceObjectControllerApi.md#delete_entity_dashboard_plugins) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Delete a Plugin -*WorkspaceObjectControllerApi* | [**delete_entity_export_definitions**](docs/WorkspaceObjectControllerApi.md#delete_entity_export_definitions) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Delete an Export Definition -*WorkspaceObjectControllerApi* | [**delete_entity_filter_contexts**](docs/WorkspaceObjectControllerApi.md#delete_entity_filter_contexts) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Delete a Filter Context -*WorkspaceObjectControllerApi* | [**delete_entity_filter_views**](docs/WorkspaceObjectControllerApi.md#delete_entity_filter_views) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Delete Filter view *WorkspaceObjectControllerApi* | [**delete_entity_knowledge_recommendations**](docs/WorkspaceObjectControllerApi.md#delete_entity_knowledge_recommendations) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | *WorkspaceObjectControllerApi* | [**delete_entity_memory_items**](docs/WorkspaceObjectControllerApi.md#delete_entity_memory_items) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | -*WorkspaceObjectControllerApi* | [**delete_entity_metrics**](docs/WorkspaceObjectControllerApi.md#delete_entity_metrics) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Delete a Metric -*WorkspaceObjectControllerApi* | [**delete_entity_user_data_filters**](docs/WorkspaceObjectControllerApi.md#delete_entity_user_data_filters) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Delete a User Data Filter -*WorkspaceObjectControllerApi* | [**delete_entity_visualization_objects**](docs/WorkspaceObjectControllerApi.md#delete_entity_visualization_objects) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Delete a Visualization Object -*WorkspaceObjectControllerApi* | [**delete_entity_workspace_data_filter_settings**](docs/WorkspaceObjectControllerApi.md#delete_entity_workspace_data_filter_settings) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Delete a Settings for Workspace Data Filter -*WorkspaceObjectControllerApi* | [**delete_entity_workspace_data_filters**](docs/WorkspaceObjectControllerApi.md#delete_entity_workspace_data_filters) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Delete a Workspace Data Filter -*WorkspaceObjectControllerApi* | [**delete_entity_workspace_settings**](docs/WorkspaceObjectControllerApi.md#delete_entity_workspace_settings) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Delete a Setting for Workspace *WorkspaceObjectControllerApi* | [**get_all_entities_aggregated_facts**](docs/WorkspaceObjectControllerApi.md#get_all_entities_aggregated_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/aggregatedFacts | -*WorkspaceObjectControllerApi* | [**get_all_entities_analytical_dashboards**](docs/WorkspaceObjectControllerApi.md#get_all_entities_analytical_dashboards) | **GET** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards | Get all Dashboards -*WorkspaceObjectControllerApi* | [**get_all_entities_attribute_hierarchies**](docs/WorkspaceObjectControllerApi.md#get_all_entities_attribute_hierarchies) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies | Get all Attribute Hierarchies -*WorkspaceObjectControllerApi* | [**get_all_entities_attributes**](docs/WorkspaceObjectControllerApi.md#get_all_entities_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributes | Get all Attributes -*WorkspaceObjectControllerApi* | [**get_all_entities_automations**](docs/WorkspaceObjectControllerApi.md#get_all_entities_automations) | **GET** /api/v1/entities/workspaces/{workspaceId}/automations | Get all Automations -*WorkspaceObjectControllerApi* | [**get_all_entities_custom_application_settings**](docs/WorkspaceObjectControllerApi.md#get_all_entities_custom_application_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings | Get all Custom Application Settings -*WorkspaceObjectControllerApi* | [**get_all_entities_dashboard_plugins**](docs/WorkspaceObjectControllerApi.md#get_all_entities_dashboard_plugins) | **GET** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins | Get all Plugins -*WorkspaceObjectControllerApi* | [**get_all_entities_datasets**](docs/WorkspaceObjectControllerApi.md#get_all_entities_datasets) | **GET** /api/v1/entities/workspaces/{workspaceId}/datasets | Get all Datasets -*WorkspaceObjectControllerApi* | [**get_all_entities_export_definitions**](docs/WorkspaceObjectControllerApi.md#get_all_entities_export_definitions) | **GET** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions | Get all Export Definitions -*WorkspaceObjectControllerApi* | [**get_all_entities_facts**](docs/WorkspaceObjectControllerApi.md#get_all_entities_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/facts | Get all Facts -*WorkspaceObjectControllerApi* | [**get_all_entities_filter_contexts**](docs/WorkspaceObjectControllerApi.md#get_all_entities_filter_contexts) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterContexts | Get all Filter Context -*WorkspaceObjectControllerApi* | [**get_all_entities_filter_views**](docs/WorkspaceObjectControllerApi.md#get_all_entities_filter_views) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterViews | Get all Filter views *WorkspaceObjectControllerApi* | [**get_all_entities_knowledge_recommendations**](docs/WorkspaceObjectControllerApi.md#get_all_entities_knowledge_recommendations) | **GET** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations | -*WorkspaceObjectControllerApi* | [**get_all_entities_labels**](docs/WorkspaceObjectControllerApi.md#get_all_entities_labels) | **GET** /api/v1/entities/workspaces/{workspaceId}/labels | Get all Labels *WorkspaceObjectControllerApi* | [**get_all_entities_memory_items**](docs/WorkspaceObjectControllerApi.md#get_all_entities_memory_items) | **GET** /api/v1/entities/workspaces/{workspaceId}/memoryItems | -*WorkspaceObjectControllerApi* | [**get_all_entities_metrics**](docs/WorkspaceObjectControllerApi.md#get_all_entities_metrics) | **GET** /api/v1/entities/workspaces/{workspaceId}/metrics | Get all Metrics -*WorkspaceObjectControllerApi* | [**get_all_entities_user_data_filters**](docs/WorkspaceObjectControllerApi.md#get_all_entities_user_data_filters) | **GET** /api/v1/entities/workspaces/{workspaceId}/userDataFilters | Get all User Data Filters -*WorkspaceObjectControllerApi* | [**get_all_entities_visualization_objects**](docs/WorkspaceObjectControllerApi.md#get_all_entities_visualization_objects) | **GET** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects | Get all Visualization Objects -*WorkspaceObjectControllerApi* | [**get_all_entities_workspace_data_filter_settings**](docs/WorkspaceObjectControllerApi.md#get_all_entities_workspace_data_filter_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings | Get all Settings for Workspace Data Filters -*WorkspaceObjectControllerApi* | [**get_all_entities_workspace_data_filters**](docs/WorkspaceObjectControllerApi.md#get_all_entities_workspace_data_filters) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters | Get all Workspace Data Filters -*WorkspaceObjectControllerApi* | [**get_all_entities_workspace_settings**](docs/WorkspaceObjectControllerApi.md#get_all_entities_workspace_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings | Get all Setting for Workspaces *WorkspaceObjectControllerApi* | [**get_entity_aggregated_facts**](docs/WorkspaceObjectControllerApi.md#get_entity_aggregated_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/{objectId} | -*WorkspaceObjectControllerApi* | [**get_entity_analytical_dashboards**](docs/WorkspaceObjectControllerApi.md#get_entity_analytical_dashboards) | **GET** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Get a Dashboard -*WorkspaceObjectControllerApi* | [**get_entity_attribute_hierarchies**](docs/WorkspaceObjectControllerApi.md#get_entity_attribute_hierarchies) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Get an Attribute Hierarchy -*WorkspaceObjectControllerApi* | [**get_entity_attributes**](docs/WorkspaceObjectControllerApi.md#get_entity_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId} | Get an Attribute -*WorkspaceObjectControllerApi* | [**get_entity_automations**](docs/WorkspaceObjectControllerApi.md#get_entity_automations) | **GET** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Get an Automation -*WorkspaceObjectControllerApi* | [**get_entity_custom_application_settings**](docs/WorkspaceObjectControllerApi.md#get_entity_custom_application_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Get a Custom Application Setting -*WorkspaceObjectControllerApi* | [**get_entity_dashboard_plugins**](docs/WorkspaceObjectControllerApi.md#get_entity_dashboard_plugins) | **GET** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Get a Plugin -*WorkspaceObjectControllerApi* | [**get_entity_datasets**](docs/WorkspaceObjectControllerApi.md#get_entity_datasets) | **GET** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Get a Dataset -*WorkspaceObjectControllerApi* | [**get_entity_export_definitions**](docs/WorkspaceObjectControllerApi.md#get_entity_export_definitions) | **GET** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Get an Export Definition -*WorkspaceObjectControllerApi* | [**get_entity_facts**](docs/WorkspaceObjectControllerApi.md#get_entity_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/facts/{objectId} | Get a Fact -*WorkspaceObjectControllerApi* | [**get_entity_filter_contexts**](docs/WorkspaceObjectControllerApi.md#get_entity_filter_contexts) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Get a Filter Context -*WorkspaceObjectControllerApi* | [**get_entity_filter_views**](docs/WorkspaceObjectControllerApi.md#get_entity_filter_views) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Get Filter view *WorkspaceObjectControllerApi* | [**get_entity_knowledge_recommendations**](docs/WorkspaceObjectControllerApi.md#get_entity_knowledge_recommendations) | **GET** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | -*WorkspaceObjectControllerApi* | [**get_entity_labels**](docs/WorkspaceObjectControllerApi.md#get_entity_labels) | **GET** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Get a Label *WorkspaceObjectControllerApi* | [**get_entity_memory_items**](docs/WorkspaceObjectControllerApi.md#get_entity_memory_items) | **GET** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | -*WorkspaceObjectControllerApi* | [**get_entity_metrics**](docs/WorkspaceObjectControllerApi.md#get_entity_metrics) | **GET** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Get a Metric -*WorkspaceObjectControllerApi* | [**get_entity_user_data_filters**](docs/WorkspaceObjectControllerApi.md#get_entity_user_data_filters) | **GET** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Get a User Data Filter -*WorkspaceObjectControllerApi* | [**get_entity_visualization_objects**](docs/WorkspaceObjectControllerApi.md#get_entity_visualization_objects) | **GET** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Get a Visualization Object -*WorkspaceObjectControllerApi* | [**get_entity_workspace_data_filter_settings**](docs/WorkspaceObjectControllerApi.md#get_entity_workspace_data_filter_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Get a Setting for Workspace Data Filter -*WorkspaceObjectControllerApi* | [**get_entity_workspace_data_filters**](docs/WorkspaceObjectControllerApi.md#get_entity_workspace_data_filters) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Get a Workspace Data Filter -*WorkspaceObjectControllerApi* | [**get_entity_workspace_settings**](docs/WorkspaceObjectControllerApi.md#get_entity_workspace_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Get a Setting for Workspace -*WorkspaceObjectControllerApi* | [**patch_entity_analytical_dashboards**](docs/WorkspaceObjectControllerApi.md#patch_entity_analytical_dashboards) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Patch a Dashboard -*WorkspaceObjectControllerApi* | [**patch_entity_attribute_hierarchies**](docs/WorkspaceObjectControllerApi.md#patch_entity_attribute_hierarchies) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Patch an Attribute Hierarchy -*WorkspaceObjectControllerApi* | [**patch_entity_attributes**](docs/WorkspaceObjectControllerApi.md#patch_entity_attributes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId} | Patch an Attribute (beta) -*WorkspaceObjectControllerApi* | [**patch_entity_automations**](docs/WorkspaceObjectControllerApi.md#patch_entity_automations) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Patch an Automation -*WorkspaceObjectControllerApi* | [**patch_entity_custom_application_settings**](docs/WorkspaceObjectControllerApi.md#patch_entity_custom_application_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Patch a Custom Application Setting -*WorkspaceObjectControllerApi* | [**patch_entity_dashboard_plugins**](docs/WorkspaceObjectControllerApi.md#patch_entity_dashboard_plugins) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Patch a Plugin -*WorkspaceObjectControllerApi* | [**patch_entity_datasets**](docs/WorkspaceObjectControllerApi.md#patch_entity_datasets) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Patch a Dataset (beta) -*WorkspaceObjectControllerApi* | [**patch_entity_export_definitions**](docs/WorkspaceObjectControllerApi.md#patch_entity_export_definitions) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Patch an Export Definition -*WorkspaceObjectControllerApi* | [**patch_entity_facts**](docs/WorkspaceObjectControllerApi.md#patch_entity_facts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/facts/{objectId} | Patch a Fact (beta) -*WorkspaceObjectControllerApi* | [**patch_entity_filter_contexts**](docs/WorkspaceObjectControllerApi.md#patch_entity_filter_contexts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Patch a Filter Context -*WorkspaceObjectControllerApi* | [**patch_entity_filter_views**](docs/WorkspaceObjectControllerApi.md#patch_entity_filter_views) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Patch Filter view *WorkspaceObjectControllerApi* | [**patch_entity_knowledge_recommendations**](docs/WorkspaceObjectControllerApi.md#patch_entity_knowledge_recommendations) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | -*WorkspaceObjectControllerApi* | [**patch_entity_labels**](docs/WorkspaceObjectControllerApi.md#patch_entity_labels) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Patch a Label (beta) *WorkspaceObjectControllerApi* | [**patch_entity_memory_items**](docs/WorkspaceObjectControllerApi.md#patch_entity_memory_items) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | -*WorkspaceObjectControllerApi* | [**patch_entity_metrics**](docs/WorkspaceObjectControllerApi.md#patch_entity_metrics) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Patch a Metric -*WorkspaceObjectControllerApi* | [**patch_entity_user_data_filters**](docs/WorkspaceObjectControllerApi.md#patch_entity_user_data_filters) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Patch a User Data Filter -*WorkspaceObjectControllerApi* | [**patch_entity_visualization_objects**](docs/WorkspaceObjectControllerApi.md#patch_entity_visualization_objects) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Patch a Visualization Object -*WorkspaceObjectControllerApi* | [**patch_entity_workspace_data_filter_settings**](docs/WorkspaceObjectControllerApi.md#patch_entity_workspace_data_filter_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Patch a Settings for Workspace Data Filter -*WorkspaceObjectControllerApi* | [**patch_entity_workspace_data_filters**](docs/WorkspaceObjectControllerApi.md#patch_entity_workspace_data_filters) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Patch a Workspace Data Filter -*WorkspaceObjectControllerApi* | [**patch_entity_workspace_settings**](docs/WorkspaceObjectControllerApi.md#patch_entity_workspace_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Patch a Setting for Workspace *WorkspaceObjectControllerApi* | [**search_entities_aggregated_facts**](docs/WorkspaceObjectControllerApi.md#search_entities_aggregated_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/search | Search request for AggregatedFact -*WorkspaceObjectControllerApi* | [**search_entities_analytical_dashboards**](docs/WorkspaceObjectControllerApi.md#search_entities_analytical_dashboards) | **POST** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search | Search request for AnalyticalDashboard -*WorkspaceObjectControllerApi* | [**search_entities_attribute_hierarchies**](docs/WorkspaceObjectControllerApi.md#search_entities_attribute_hierarchies) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search | Search request for AttributeHierarchy -*WorkspaceObjectControllerApi* | [**search_entities_attributes**](docs/WorkspaceObjectControllerApi.md#search_entities_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributes/search | Search request for Attribute *WorkspaceObjectControllerApi* | [**search_entities_automation_results**](docs/WorkspaceObjectControllerApi.md#search_entities_automation_results) | **POST** /api/v1/entities/workspaces/{workspaceId}/automationResults/search | Search request for AutomationResult -*WorkspaceObjectControllerApi* | [**search_entities_automations**](docs/WorkspaceObjectControllerApi.md#search_entities_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations/search | Search request for Automation -*WorkspaceObjectControllerApi* | [**search_entities_custom_application_settings**](docs/WorkspaceObjectControllerApi.md#search_entities_custom_application_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search | Search request for CustomApplicationSetting -*WorkspaceObjectControllerApi* | [**search_entities_dashboard_plugins**](docs/WorkspaceObjectControllerApi.md#search_entities_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search | Search request for DashboardPlugin -*WorkspaceObjectControllerApi* | [**search_entities_datasets**](docs/WorkspaceObjectControllerApi.md#search_entities_datasets) | **POST** /api/v1/entities/workspaces/{workspaceId}/datasets/search | Search request for Dataset -*WorkspaceObjectControllerApi* | [**search_entities_export_definitions**](docs/WorkspaceObjectControllerApi.md#search_entities_export_definitions) | **POST** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/search | Search request for ExportDefinition -*WorkspaceObjectControllerApi* | [**search_entities_facts**](docs/WorkspaceObjectControllerApi.md#search_entities_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/facts/search | Search request for Fact -*WorkspaceObjectControllerApi* | [**search_entities_filter_contexts**](docs/WorkspaceObjectControllerApi.md#search_entities_filter_contexts) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterContexts/search | Search request for FilterContext -*WorkspaceObjectControllerApi* | [**search_entities_filter_views**](docs/WorkspaceObjectControllerApi.md#search_entities_filter_views) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterViews/search | Search request for FilterView -*WorkspaceObjectControllerApi* | [**search_entities_knowledge_recommendations**](docs/WorkspaceObjectControllerApi.md#search_entities_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search | -*WorkspaceObjectControllerApi* | [**search_entities_labels**](docs/WorkspaceObjectControllerApi.md#search_entities_labels) | **POST** /api/v1/entities/workspaces/{workspaceId}/labels/search | Search request for Label +*WorkspaceObjectControllerApi* | [**search_entities_knowledge_recommendations**](docs/WorkspaceObjectControllerApi.md#search_entities_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search | The search endpoint (beta) *WorkspaceObjectControllerApi* | [**search_entities_memory_items**](docs/WorkspaceObjectControllerApi.md#search_entities_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems/search | Search request for MemoryItem -*WorkspaceObjectControllerApi* | [**search_entities_metrics**](docs/WorkspaceObjectControllerApi.md#search_entities_metrics) | **POST** /api/v1/entities/workspaces/{workspaceId}/metrics/search | Search request for Metric -*WorkspaceObjectControllerApi* | [**search_entities_user_data_filters**](docs/WorkspaceObjectControllerApi.md#search_entities_user_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/search | Search request for UserDataFilter -*WorkspaceObjectControllerApi* | [**search_entities_visualization_objects**](docs/WorkspaceObjectControllerApi.md#search_entities_visualization_objects) | **POST** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/search | Search request for VisualizationObject -*WorkspaceObjectControllerApi* | [**search_entities_workspace_data_filter_settings**](docs/WorkspaceObjectControllerApi.md#search_entities_workspace_data_filter_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/search | Search request for WorkspaceDataFilterSetting -*WorkspaceObjectControllerApi* | [**search_entities_workspace_data_filters**](docs/WorkspaceObjectControllerApi.md#search_entities_workspace_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/search | Search request for WorkspaceDataFilter -*WorkspaceObjectControllerApi* | [**search_entities_workspace_settings**](docs/WorkspaceObjectControllerApi.md#search_entities_workspace_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/search | -*WorkspaceObjectControllerApi* | [**update_entity_analytical_dashboards**](docs/WorkspaceObjectControllerApi.md#update_entity_analytical_dashboards) | **PUT** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Put Dashboards -*WorkspaceObjectControllerApi* | [**update_entity_attribute_hierarchies**](docs/WorkspaceObjectControllerApi.md#update_entity_attribute_hierarchies) | **PUT** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Put an Attribute Hierarchy -*WorkspaceObjectControllerApi* | [**update_entity_automations**](docs/WorkspaceObjectControllerApi.md#update_entity_automations) | **PUT** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Put an Automation -*WorkspaceObjectControllerApi* | [**update_entity_custom_application_settings**](docs/WorkspaceObjectControllerApi.md#update_entity_custom_application_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Put a Custom Application Setting -*WorkspaceObjectControllerApi* | [**update_entity_dashboard_plugins**](docs/WorkspaceObjectControllerApi.md#update_entity_dashboard_plugins) | **PUT** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Put a Plugin -*WorkspaceObjectControllerApi* | [**update_entity_export_definitions**](docs/WorkspaceObjectControllerApi.md#update_entity_export_definitions) | **PUT** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Put an Export Definition -*WorkspaceObjectControllerApi* | [**update_entity_filter_contexts**](docs/WorkspaceObjectControllerApi.md#update_entity_filter_contexts) | **PUT** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Put a Filter Context -*WorkspaceObjectControllerApi* | [**update_entity_filter_views**](docs/WorkspaceObjectControllerApi.md#update_entity_filter_views) | **PUT** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Put Filter views *WorkspaceObjectControllerApi* | [**update_entity_knowledge_recommendations**](docs/WorkspaceObjectControllerApi.md#update_entity_knowledge_recommendations) | **PUT** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | *WorkspaceObjectControllerApi* | [**update_entity_memory_items**](docs/WorkspaceObjectControllerApi.md#update_entity_memory_items) | **PUT** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | -*WorkspaceObjectControllerApi* | [**update_entity_metrics**](docs/WorkspaceObjectControllerApi.md#update_entity_metrics) | **PUT** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Put a Metric -*WorkspaceObjectControllerApi* | [**update_entity_user_data_filters**](docs/WorkspaceObjectControllerApi.md#update_entity_user_data_filters) | **PUT** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Put a User Data Filter -*WorkspaceObjectControllerApi* | [**update_entity_visualization_objects**](docs/WorkspaceObjectControllerApi.md#update_entity_visualization_objects) | **PUT** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Put a Visualization Object -*WorkspaceObjectControllerApi* | [**update_entity_workspace_data_filter_settings**](docs/WorkspaceObjectControllerApi.md#update_entity_workspace_data_filter_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Put a Settings for Workspace Data Filter -*WorkspaceObjectControllerApi* | [**update_entity_workspace_data_filters**](docs/WorkspaceObjectControllerApi.md#update_entity_workspace_data_filters) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Put a Workspace Data Filter -*WorkspaceObjectControllerApi* | [**update_entity_workspace_settings**](docs/WorkspaceObjectControllerApi.md#update_entity_workspace_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Put a Setting for a Workspace +*WorkspaceSettingControllerApi* | [**create_entity_workspace_settings**](docs/WorkspaceSettingControllerApi.md#create_entity_workspace_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings | Post Settings for Workspaces +*WorkspaceSettingControllerApi* | [**delete_entity_workspace_settings**](docs/WorkspaceSettingControllerApi.md#delete_entity_workspace_settings) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Delete a Setting for Workspace +*WorkspaceSettingControllerApi* | [**get_all_entities_workspace_settings**](docs/WorkspaceSettingControllerApi.md#get_all_entities_workspace_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings | Get all Setting for Workspaces +*WorkspaceSettingControllerApi* | [**get_entity_workspace_settings**](docs/WorkspaceSettingControllerApi.md#get_entity_workspace_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Get a Setting for Workspace +*WorkspaceSettingControllerApi* | [**patch_entity_workspace_settings**](docs/WorkspaceSettingControllerApi.md#patch_entity_workspace_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Patch a Setting for Workspace +*WorkspaceSettingControllerApi* | [**search_entities_workspace_settings**](docs/WorkspaceSettingControllerApi.md#search_entities_workspace_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/search | The search endpoint (beta) +*WorkspaceSettingControllerApi* | [**update_entity_workspace_settings**](docs/WorkspaceSettingControllerApi.md#update_entity_workspace_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Put a Setting for a Workspace ## Documentation For Models @@ -1353,6 +1360,8 @@ Class | Method | HTTP request | Description - [CustomOverride](docs/CustomOverride.md) - [DashboardAttributeFilter](docs/DashboardAttributeFilter.md) - [DashboardAttributeFilterAttributeFilter](docs/DashboardAttributeFilterAttributeFilter.md) + - [DashboardContext](docs/DashboardContext.md) + - [DashboardContextWidgetsInner](docs/DashboardContextWidgetsInner.md) - [DashboardDateFilter](docs/DashboardDateFilter.md) - [DashboardDateFilterDateFilter](docs/DashboardDateFilterDateFilter.md) - [DashboardExportSettings](docs/DashboardExportSettings.md) @@ -1527,6 +1536,7 @@ Class | Method | HTTP request | Description - [GetAiLakeOperation200Response](docs/GetAiLakeOperation200Response.md) - [GetImageExport202ResponseInner](docs/GetImageExport202ResponseInner.md) - [GetQualityIssuesResponse](docs/GetQualityIssuesResponse.md) + - [GetServiceStatusResponse](docs/GetServiceStatusResponse.md) - [GrainIdentifier](docs/GrainIdentifier.md) - [GrantedPermission](docs/GrantedPermission.md) - [GranularitiesFormatting](docs/GranularitiesFormatting.md) @@ -1545,6 +1555,8 @@ Class | Method | HTTP request | Description - [InlineFilterDefinitionInline](docs/InlineFilterDefinitionInline.md) - [InlineMeasureDefinition](docs/InlineMeasureDefinition.md) - [InlineMeasureDefinitionInline](docs/InlineMeasureDefinitionInline.md) + - [InsightWidgetDescriptor](docs/InsightWidgetDescriptor.md) + - [InsightWidgetDescriptorAllOf](docs/InsightWidgetDescriptorAllOf.md) - [IntroSlideTemplate](docs/IntroSlideTemplate.md) - [JsonApiAggregatedFactLinkage](docs/JsonApiAggregatedFactLinkage.md) - [JsonApiAggregatedFactOut](docs/JsonApiAggregatedFactOut.md) @@ -1917,7 +1929,6 @@ Class | Method | HTTP request | Description - [JsonApiLlmProviderOutList](docs/JsonApiLlmProviderOutList.md) - [JsonApiLlmProviderOutWithLinks](docs/JsonApiLlmProviderOutWithLinks.md) - [JsonApiLlmProviderPatch](docs/JsonApiLlmProviderPatch.md) - - [JsonApiLlmProviderPatchAttributes](docs/JsonApiLlmProviderPatchAttributes.md) - [JsonApiLlmProviderPatchDocument](docs/JsonApiLlmProviderPatchDocument.md) - [JsonApiMemoryItemIn](docs/JsonApiMemoryItemIn.md) - [JsonApiMemoryItemInAttributes](docs/JsonApiMemoryItemInAttributes.md) @@ -1940,7 +1951,6 @@ Class | Method | HTTP request | Description - [JsonApiMetricOut](docs/JsonApiMetricOut.md) - [JsonApiMetricOutAttributes](docs/JsonApiMetricOutAttributes.md) - [JsonApiMetricOutDocument](docs/JsonApiMetricOutDocument.md) - - [JsonApiMetricOutIncludes](docs/JsonApiMetricOutIncludes.md) - [JsonApiMetricOutList](docs/JsonApiMetricOutList.md) - [JsonApiMetricOutRelationships](docs/JsonApiMetricOutRelationships.md) - [JsonApiMetricOutWithLinks](docs/JsonApiMetricOutWithLinks.md) @@ -2065,6 +2075,7 @@ Class | Method | HTTP request | Description - [JsonApiVisualizationObjectOut](docs/JsonApiVisualizationObjectOut.md) - [JsonApiVisualizationObjectOutAttributes](docs/JsonApiVisualizationObjectOutAttributes.md) - [JsonApiVisualizationObjectOutDocument](docs/JsonApiVisualizationObjectOutDocument.md) + - [JsonApiVisualizationObjectOutIncludes](docs/JsonApiVisualizationObjectOutIncludes.md) - [JsonApiVisualizationObjectOutList](docs/JsonApiVisualizationObjectOutList.md) - [JsonApiVisualizationObjectOutWithLinks](docs/JsonApiVisualizationObjectOutWithLinks.md) - [JsonApiVisualizationObjectPatch](docs/JsonApiVisualizationObjectPatch.md) @@ -2147,6 +2158,9 @@ Class | Method | HTTP request | Description - [ListKnowledgeDocumentsResponseDto](docs/ListKnowledgeDocumentsResponseDto.md) - [ListLinks](docs/ListLinks.md) - [ListLinksAllOf](docs/ListLinksAllOf.md) + - [ListLlmProviderModelsRequest](docs/ListLlmProviderModelsRequest.md) + - [ListLlmProviderModelsRequestProviderConfig](docs/ListLlmProviderModelsRequestProviderConfig.md) + - [ListLlmProviderModelsResponse](docs/ListLlmProviderModelsResponse.md) - [ListServicesResponse](docs/ListServicesResponse.md) - [LlmModel](docs/LlmModel.md) - [LlmProviderAuth](docs/LlmProviderAuth.md) @@ -2186,6 +2200,8 @@ Class | Method | HTTP request | Description - [NotificationsMetaTotal](docs/NotificationsMetaTotal.md) - [ObjectLinks](docs/ObjectLinks.md) - [ObjectLinksContainer](docs/ObjectLinksContainer.md) + - [ObjectReference](docs/ObjectReference.md) + - [ObjectReferenceGroup](docs/ObjectReferenceGroup.md) - [OpenAIProviderConfig](docs/OpenAIProviderConfig.md) - [OpenAiApiKeyAuth](docs/OpenAiApiKeyAuth.md) - [OpenAiApiKeyAuthAllOf](docs/OpenAiApiKeyAuthAllOf.md) @@ -2258,6 +2274,8 @@ Class | Method | HTTP request | Description - [ResultDimension](docs/ResultDimension.md) - [ResultDimensionHeader](docs/ResultDimensionHeader.md) - [ResultSpec](docs/ResultSpec.md) + - [RichTextWidgetDescriptor](docs/RichTextWidgetDescriptor.md) + - [RichTextWidgetDescriptorAllOf](docs/RichTextWidgetDescriptorAllOf.md) - [RouteResult](docs/RouteResult.md) - [RsaSpecification](docs/RsaSpecification.md) - [RulePermission](docs/RulePermission.md) @@ -2306,8 +2324,8 @@ Class | Method | HTTP request | Description - [TabularExportRequest](docs/TabularExportRequest.md) - [TestDefinitionRequest](docs/TestDefinitionRequest.md) - [TestDestinationRequest](docs/TestDestinationRequest.md) + - [TestLlmProviderByIdRequest](docs/TestLlmProviderByIdRequest.md) - [TestLlmProviderDefinitionRequest](docs/TestLlmProviderDefinitionRequest.md) - - [TestLlmProviderDefinitionRequestProviderConfig](docs/TestLlmProviderDefinitionRequestProviderConfig.md) - [TestLlmProviderResponse](docs/TestLlmProviderResponse.md) - [TestNotification](docs/TestNotification.md) - [TestNotificationAllOf](docs/TestNotificationAllOf.md) @@ -2319,8 +2337,11 @@ Class | Method | HTTP request | Description - [TotalDimension](docs/TotalDimension.md) - [TotalExecutionResultHeader](docs/TotalExecutionResultHeader.md) - [TotalResultHeader](docs/TotalResultHeader.md) + - [TrendingObjectItem](docs/TrendingObjectItem.md) + - [TrendingObjectsResult](docs/TrendingObjectsResult.md) - [TriggerAutomationRequest](docs/TriggerAutomationRequest.md) - [TriggerQualityIssuesCalculationResponse](docs/TriggerQualityIssuesCalculationResponse.md) + - [UIContext](docs/UIContext.md) - [UpsertKnowledgeDocumentRequestDto](docs/UpsertKnowledgeDocumentRequestDto.md) - [UpsertKnowledgeDocumentResponseDto](docs/UpsertKnowledgeDocumentResponseDto.md) - [UserAssignee](docs/UserAssignee.md) @@ -2346,6 +2367,8 @@ Class | Method | HTTP request | Description - [VisibleFilter](docs/VisibleFilter.md) - [VisualExportRequest](docs/VisualExportRequest.md) - [VisualizationConfig](docs/VisualizationConfig.md) + - [VisualizationSwitcherWidgetDescriptor](docs/VisualizationSwitcherWidgetDescriptor.md) + - [VisualizationSwitcherWidgetDescriptorAllOf](docs/VisualizationSwitcherWidgetDescriptorAllOf.md) - [Webhook](docs/Webhook.md) - [WebhookAllOf](docs/WebhookAllOf.md) - [WebhookAutomationInfo](docs/WebhookAutomationInfo.md) @@ -2355,6 +2378,7 @@ Class | Method | HTTP request | Description - [WhatIfMeasureAdjustmentConfig](docs/WhatIfMeasureAdjustmentConfig.md) - [WhatIfScenarioConfig](docs/WhatIfScenarioConfig.md) - [WhatIfScenarioItem](docs/WhatIfScenarioItem.md) + - [WidgetDescriptor](docs/WidgetDescriptor.md) - [WidgetSlidesTemplate](docs/WidgetSlidesTemplate.md) - [WorkspaceAutomationIdentifier](docs/WorkspaceAutomationIdentifier.md) - [WorkspaceAutomationManagementBulkRequest](docs/WorkspaceAutomationManagementBulkRequest.md) diff --git a/gooddata-api-client/docs/AIApi.md b/gooddata-api-client/docs/AIApi.md index de5a891d8..0fcd8857e 100644 --- a/gooddata-api-client/docs/AIApi.md +++ b/gooddata-api-client/docs/AIApi.md @@ -17,7 +17,7 @@ Method | HTTP request | Description [**metadata_sync_organization**](AIApi.md#metadata_sync_organization) | **POST** /api/v1/actions/organization/metadataSync | (BETA) Sync organization scope Metadata to other services [**patch_entity_knowledge_recommendations**](AIApi.md#patch_entity_knowledge_recommendations) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | [**patch_entity_memory_items**](AIApi.md#patch_entity_memory_items) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | -[**search_entities_knowledge_recommendations**](AIApi.md#search_entities_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search | +[**search_entities_knowledge_recommendations**](AIApi.md#search_entities_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search | The search endpoint (beta) [**search_entities_memory_items**](AIApi.md#search_entities_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems/search | Search request for MemoryItem [**update_entity_knowledge_recommendations**](AIApi.md#update_entity_knowledge_recommendations) | **PUT** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | [**update_entity_memory_items**](AIApi.md#update_entity_memory_items) | **PUT** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | @@ -1157,7 +1157,7 @@ No authorization required # **search_entities_knowledge_recommendations** > JsonApiKnowledgeRecommendationOutList search_entities_knowledge_recommendations(workspace_id, entity_search_body) - +The search endpoint (beta) ### Example @@ -1205,6 +1205,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: + # The search endpoint (beta) api_response = api_instance.search_entities_knowledge_recommendations(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -1213,6 +1214,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: + # The search endpoint (beta) api_response = api_instance.search_entities_knowledge_recommendations(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/AILakeApi.md b/gooddata-api-client/docs/AILakeApi.md index cd4bdfad3..578129980 100644 --- a/gooddata-api-client/docs/AILakeApi.md +++ b/gooddata-api-client/docs/AILakeApi.md @@ -7,6 +7,7 @@ Method | HTTP request | Description [**deprovision_ai_lake_database_instance**](AILakeApi.md#deprovision_ai_lake_database_instance) | **DELETE** /api/v1/ailake/database/instances/{instanceId} | (BETA) Delete an existing AILake Database instance [**get_ai_lake_database_instance**](AILakeApi.md#get_ai_lake_database_instance) | **GET** /api/v1/ailake/database/instances/{instanceId} | (BETA) Get the specified AILake Database instance [**get_ai_lake_operation**](AILakeApi.md#get_ai_lake_operation) | **GET** /api/v1/ailake/operations/{operationId} | (BETA) Get Long Running Operation details +[**get_ai_lake_service_status**](AILakeApi.md#get_ai_lake_service_status) | **GET** /api/v1/ailake/services/{serviceId}/status | (BETA) Get AI Lake service status [**list_ai_lake_database_instances**](AILakeApi.md#list_ai_lake_database_instances) | **GET** /api/v1/ailake/database/instances | (BETA) List AI Lake Database instances [**list_ai_lake_services**](AILakeApi.md#list_ai_lake_services) | **GET** /api/v1/ailake/services | (BETA) List AI Lake services [**provision_ai_lake_database_instance**](AILakeApi.md#provision_ai_lake_database_instance) | **POST** /api/v1/ailake/database/instances | (BETA) Create a new AILake Database instance @@ -224,6 +225,73 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **get_ai_lake_service_status** +> GetServiceStatusResponse get_ai_lake_service_status(service_id) + +(BETA) Get AI Lake service status + +(BETA) Returns the status of a service in the organization's AI Lake. The status is controller-specific (e.g., available commands, readiness). + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import ai_lake_api +from gooddata_api_client.model.get_service_status_response import GetServiceStatusResponse +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = ai_lake_api.AILakeApi(api_client) + service_id = "serviceId_example" # str | + + # example passing only required values which don't have defaults set + try: + # (BETA) Get AI Lake service status + api_response = api_instance.get_ai_lake_service_status(service_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AILakeApi->get_ai_lake_service_status: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| | + +### Return type + +[**GetServiceStatusResponse**](GetServiceStatusResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | AI Lake service status successfully retrieved | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **list_ai_lake_database_instances** > ListDatabaseInstancesResponse list_ai_lake_database_instances() diff --git a/gooddata-api-client/docs/ActionsApi.md b/gooddata-api-client/docs/ActionsApi.md index 00977d702..da8399d8d 100644 --- a/gooddata-api-client/docs/ActionsApi.md +++ b/gooddata-api-client/docs/ActionsApi.md @@ -65,6 +65,8 @@ Method | HTTP request | Description [**key_driver_analysis**](ActionsApi.md#key_driver_analysis) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers | (EXPERIMENTAL) Compute key driver analysis [**key_driver_analysis_result**](ActionsApi.md#key_driver_analysis_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers/result/{resultId} | (EXPERIMENTAL) Get key driver analysis result [**list_documents**](ActionsApi.md#list_documents) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/knowledge/documents | +[**list_llm_provider_models**](ActionsApi.md#list_llm_provider_models) | **POST** /api/v1/actions/ai/llmProvider/listModels | List LLM Provider Models +[**list_llm_provider_models_by_id**](ActionsApi.md#list_llm_provider_models_by_id) | **POST** /api/v1/actions/ai/llmProvider/{llmProviderId}/listModels | List LLM Provider Models By Id [**list_workspace_user_groups**](ActionsApi.md#list_workspace_user_groups) | **GET** /api/v1/actions/workspaces/{workspaceId}/userGroups | [**list_workspace_users**](ActionsApi.md#list_workspace_users) | **GET** /api/v1/actions/workspaces/{workspaceId}/users | [**manage_dashboard_permissions**](ActionsApi.md#manage_dashboard_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/managePermissions | Manage Permissions for a Dashboard @@ -106,6 +108,7 @@ Method | HTTP request | Description [**test_llm_provider**](ActionsApi.md#test_llm_provider) | **POST** /api/v1/actions/ai/llmProvider/test | Test LLM Provider [**test_llm_provider_by_id**](ActionsApi.md#test_llm_provider_by_id) | **POST** /api/v1/actions/ai/llmProvider/{llmProviderId}/test | Test LLM Provider By Id [**test_notification_channel**](ActionsApi.md#test_notification_channel) | **POST** /api/v1/actions/notificationChannels/test | Test notification channel. +[**trending_objects**](ActionsApi.md#trending_objects) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/trendingObjects | Get Trending Analytics Catalog Objects [**trigger_automation**](ActionsApi.md#trigger_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/trigger | Trigger automation. [**trigger_existing_automation**](ActionsApi.md#trigger_existing_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/trigger | Trigger existing automation. [**trigger_quality_issues_calculation**](ActionsApi.md#trigger_quality_issues_calculation) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/issues/triggerCheck | Trigger Quality Issues Calculation @@ -178,6 +181,28 @@ with gooddata_api_client.ApiClient() as api_client: type="type_example", workspace_id="workspace_id_example", ), + referenced_objects=[ + ObjectReferenceGroup( + context=ObjectReference( + id="id_example", + type="WIDGET", + ), + objects=[ + ObjectReference( + id="id_example", + type="WIDGET", + ), + ], + ), + ], + view=UIContext( + dashboard=DashboardContext( + id="id_example", + widgets=[ + DashboardContextWidgetsInner(None), + ], + ), + ), ), ) # ChatRequest | @@ -355,6 +380,28 @@ with gooddata_api_client.ApiClient() as api_client: type="type_example", workspace_id="workspace_id_example", ), + referenced_objects=[ + ObjectReferenceGroup( + context=ObjectReference( + id="id_example", + type="WIDGET", + ), + objects=[ + ObjectReference( + id="id_example", + type="WIDGET", + ), + ], + ), + ], + view=UIContext( + dashboard=DashboardContext( + id="id_example", + widgets=[ + DashboardContextWidgetsInner(None), + ], + ), + ), ), ) # ChatRequest | @@ -2578,6 +2625,7 @@ with gooddata_api_client.ApiClient() as api_client: settings=Settings( delimiter="U", export_info=True, + grand_totals_position="pinnedBottom", merge_headers=True, page_orientation="PORTRAIT", page_size="A4", @@ -5171,6 +5219,8 @@ with gooddata_api_client.ApiClient() as api_client: size = 50 # int | (optional) if omitted the server will use the default value of 50 page_token = "pageToken_example" # str | (optional) meta_include = "metaInclude_example" # str | (optional) + state = "state_example" # str | (optional) + query = "query_example" # str | (optional) # example passing only required values which don't have defaults set try: @@ -5182,7 +5232,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - api_response = api_instance.list_documents(workspace_id, scopes=scopes, size=size, page_token=page_token, meta_include=meta_include) + api_response = api_instance.list_documents(workspace_id, scopes=scopes, size=size, page_token=page_token, meta_include=meta_include, state=state, query=query) pprint(api_response) except gooddata_api_client.ApiException as e: print("Exception when calling ActionsApi->list_documents: %s\n" % e) @@ -5198,6 +5248,8 @@ Name | Type | Description | Notes **size** | **int**| | [optional] if omitted the server will use the default value of 50 **page_token** | **str**| | [optional] **meta_include** | **str**| | [optional] + **state** | **str**| | [optional] + **query** | **str**| | [optional] ### Return type @@ -5213,6 +5265,143 @@ No authorization required - **Accept**: application/json +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_llm_provider_models** +> ListLlmProviderModelsResponse list_llm_provider_models(list_llm_provider_models_request) + +List LLM Provider Models + +Lists models available on an LLM provider with a full definition. For Azure AI Foundry providers, the model family will be set to UNKNOWN because the endpoint does not expose the family. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.list_llm_provider_models_request import ListLlmProviderModelsRequest +from gooddata_api_client.model.list_llm_provider_models_response import ListLlmProviderModelsResponse +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = actions_api.ActionsApi(api_client) + list_llm_provider_models_request = ListLlmProviderModelsRequest( + provider_config=ListLlmProviderModelsRequestProviderConfig(None), + ) # ListLlmProviderModelsRequest | + + # example passing only required values which don't have defaults set + try: + # List LLM Provider Models + api_response = api_instance.list_llm_provider_models(list_llm_provider_models_request) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->list_llm_provider_models: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **list_llm_provider_models_request** | [**ListLlmProviderModelsRequest**](ListLlmProviderModelsRequest.md)| | + +### Return type + +[**ListLlmProviderModelsResponse**](ListLlmProviderModelsResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_llm_provider_models_by_id** +> ListLlmProviderModelsResponse list_llm_provider_models_by_id(llm_provider_id) + +List LLM Provider Models By Id + +Lists models available on an existing LLM provider by its ID. For Azure AI Foundry providers, the model family will be set to UNKNOWN because the endpoint does not expose the family. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.list_llm_provider_models_response import ListLlmProviderModelsResponse +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = actions_api.ActionsApi(api_client) + llm_provider_id = "llmProviderId_example" # str | + + # example passing only required values which don't have defaults set + try: + # List LLM Provider Models By Id + api_response = api_instance.list_llm_provider_models_by_id(llm_provider_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->list_llm_provider_models_by_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **llm_provider_id** | **str**| | + +### Return type + +[**ListLlmProviderModelsResponse**](ListLlmProviderModelsResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + ### HTTP response details | Status code | Description | Response headers | @@ -7107,7 +7296,7 @@ No authorization required Get a single execution result -Gets a single execution result. +Gets a single execution result. Note that the Arrow File and Arrow Stream content types are currently in BETA. ### Example @@ -7131,6 +7320,7 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = actions_api.ActionsApi(api_client) workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier result_id = "a9b28f9dc55f37ea9f4a5fb0c76895923591e781" # str | Result ID + x_gdc_cancel_token = "X-GDC-CANCEL-TOKEN_example" # str | (optional) offset = [ offset=1,10, ] # [int] | Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM. (optional) if omitted the server will use the default value of [] @@ -7140,7 +7330,6 @@ with gooddata_api_client.ApiClient() as api_client: excluded_total_dimensions = [ "excludedTotalDimensions=dim_0,dim_1", ] # [str] | Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions. (optional) if omitted the server will use the default value of [] - x_gdc_cancel_token = "X-GDC-CANCEL-TOKEN_example" # str | (optional) # example passing only required values which don't have defaults set try: @@ -7154,7 +7343,7 @@ with gooddata_api_client.ApiClient() as api_client: # and optional values try: # Get a single execution result - api_response = api_instance.retrieve_result(workspace_id, result_id, offset=offset, limit=limit, excluded_total_dimensions=excluded_total_dimensions, x_gdc_cancel_token=x_gdc_cancel_token) + api_response = api_instance.retrieve_result(workspace_id, result_id, x_gdc_cancel_token=x_gdc_cancel_token, offset=offset, limit=limit, excluded_total_dimensions=excluded_total_dimensions) pprint(api_response) except gooddata_api_client.ApiException as e: print("Exception when calling ActionsApi->retrieve_result: %s\n" % e) @@ -7167,10 +7356,10 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| Workspace identifier | **result_id** | **str**| Result ID | + **x_gdc_cancel_token** | **str**| | [optional] **offset** | **[int]**| Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM. | [optional] if omitted the server will use the default value of [] **limit** | **[int]**| Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM. | [optional] if omitted the server will use the default value of [] **excluded_total_dimensions** | **[str]**| Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions. | [optional] if omitted the server will use the default value of [] - **x_gdc_cancel_token** | **str**| | [optional] ### Return type @@ -7183,7 +7372,7 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json + - **Accept**: application/json, application/vnd.apache.arrow.file, application/vnd.apache.arrow.stream ### HTTP response details @@ -8113,7 +8302,7 @@ with gooddata_api_client.ApiClient() as api_client: id="id_example", ), ], - provider_config=TestLlmProviderDefinitionRequestProviderConfig(None), + provider_config=ListLlmProviderModelsRequestProviderConfig(None), ) # TestLlmProviderDefinitionRequest | # example passing only required values which don't have defaults set @@ -8169,6 +8358,7 @@ import time import gooddata_api_client from gooddata_api_client.api import actions_api from gooddata_api_client.model.test_llm_provider_response import TestLlmProviderResponse +from gooddata_api_client.model.test_llm_provider_by_id_request import TestLlmProviderByIdRequest 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. @@ -8182,6 +8372,15 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = actions_api.ActionsApi(api_client) llm_provider_id = "llmProviderId_example" # str | + test_llm_provider_by_id_request = TestLlmProviderByIdRequest( + models=[ + LlmModel( + family="OPENAI", + id="id_example", + ), + ], + provider_config=ListLlmProviderModelsRequestProviderConfig(None), + ) # TestLlmProviderByIdRequest | (optional) # example passing only required values which don't have defaults set try: @@ -8190,6 +8389,15 @@ with gooddata_api_client.ApiClient() as api_client: pprint(api_response) except gooddata_api_client.ApiException as e: print("Exception when calling ActionsApi->test_llm_provider_by_id: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Test LLM Provider By Id + api_response = api_instance.test_llm_provider_by_id(llm_provider_id, test_llm_provider_by_id_request=test_llm_provider_by_id_request) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->test_llm_provider_by_id: %s\n" % e) ``` @@ -8198,6 +8406,7 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **llm_provider_id** | **str**| | + **test_llm_provider_by_id_request** | [**TestLlmProviderByIdRequest**](TestLlmProviderByIdRequest.md)| | [optional] ### Return type @@ -8209,7 +8418,7 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined + - **Content-Type**: application/json - **Accept**: application/json @@ -8296,6 +8505,73 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **trending_objects** +> TrendingObjectsResult trending_objects(workspace_id) + +Get Trending Analytics Catalog Objects + +Returns a list of trending objects for this workspace + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.trending_objects_result import TrendingObjectsResult +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = actions_api.ActionsApi(api_client) + workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier + + # example passing only required values which don't have defaults set + try: + # Get Trending Analytics Catalog Objects + api_response = api_instance.trending_objects(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->trending_objects: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| Workspace identifier | + +### Return type + +[**TrendingObjectsResult**](TrendingObjectsResult.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **trigger_automation** > trigger_automation(workspace_id, trigger_automation_request) @@ -8534,6 +8810,7 @@ with gooddata_api_client.ApiClient() as api_client: settings=Settings( delimiter="U", export_info=True, + grand_totals_position="pinnedBottom", merge_headers=True, page_orientation="PORTRAIT", page_size="A4", diff --git a/gooddata-api-client/docs/AnalyticalDashboardControllerApi.md b/gooddata-api-client/docs/AnalyticalDashboardControllerApi.md new file mode 100644 index 000000000..f9c0b96bc --- /dev/null +++ b/gooddata-api-client/docs/AnalyticalDashboardControllerApi.md @@ -0,0 +1,673 @@ +# gooddata_api_client.AnalyticalDashboardControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_analytical_dashboards**](AnalyticalDashboardControllerApi.md#create_entity_analytical_dashboards) | **POST** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards | Post Dashboards +[**delete_entity_analytical_dashboards**](AnalyticalDashboardControllerApi.md#delete_entity_analytical_dashboards) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Delete a Dashboard +[**get_all_entities_analytical_dashboards**](AnalyticalDashboardControllerApi.md#get_all_entities_analytical_dashboards) | **GET** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards | Get all Dashboards +[**get_entity_analytical_dashboards**](AnalyticalDashboardControllerApi.md#get_entity_analytical_dashboards) | **GET** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Get a Dashboard +[**patch_entity_analytical_dashboards**](AnalyticalDashboardControllerApi.md#patch_entity_analytical_dashboards) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Patch a Dashboard +[**search_entities_analytical_dashboards**](AnalyticalDashboardControllerApi.md#search_entities_analytical_dashboards) | **POST** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search | The search endpoint (beta) +[**update_entity_analytical_dashboards**](AnalyticalDashboardControllerApi.md#update_entity_analytical_dashboards) | **PUT** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Put Dashboards + + +# **create_entity_analytical_dashboards** +> JsonApiAnalyticalDashboardOutDocument create_entity_analytical_dashboards(workspace_id, json_api_analytical_dashboard_post_optional_id_document) + +Post Dashboards + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import analytical_dashboard_controller_api +from gooddata_api_client.model.json_api_analytical_dashboard_post_optional_id_document import JsonApiAnalyticalDashboardPostOptionalIdDocument +from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = analytical_dashboard_controller_api.AnalyticalDashboardControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + json_api_analytical_dashboard_post_optional_id_document = JsonApiAnalyticalDashboardPostOptionalIdDocument( + data=JsonApiAnalyticalDashboardPostOptionalId( + attributes=JsonApiAnalyticalDashboardInAttributes( + are_relations_valid=True, + content={}, + description="description_example", + summary="summary_example", + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="analyticalDashboard", + ), + ) # JsonApiAnalyticalDashboardPostOptionalIdDocument | + include = [ + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = [ + "metaInclude=permissions,origin,accessInfo,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Dashboards + api_response = api_instance.create_entity_analytical_dashboards(workspace_id, json_api_analytical_dashboard_post_optional_id_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AnalyticalDashboardControllerApi->create_entity_analytical_dashboards: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Dashboards + api_response = api_instance.create_entity_analytical_dashboards(workspace_id, json_api_analytical_dashboard_post_optional_id_document, include=include, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AnalyticalDashboardControllerApi->create_entity_analytical_dashboards: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_analytical_dashboard_post_optional_id_document** | [**JsonApiAnalyticalDashboardPostOptionalIdDocument**](JsonApiAnalyticalDashboardPostOptionalIdDocument.md)| | + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiAnalyticalDashboardOutDocument**](JsonApiAnalyticalDashboardOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_entity_analytical_dashboards** +> delete_entity_analytical_dashboards(workspace_id, object_id) + +Delete a Dashboard + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import analytical_dashboard_controller_api +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = analytical_dashboard_controller_api.AnalyticalDashboardControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Delete a Dashboard + api_instance.delete_entity_analytical_dashboards(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling AnalyticalDashboardControllerApi->delete_entity_analytical_dashboards: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete a Dashboard + api_instance.delete_entity_analytical_dashboards(workspace_id, object_id, filter=filter) + except gooddata_api_client.ApiException as e: + print("Exception when calling AnalyticalDashboardControllerApi->delete_entity_analytical_dashboards: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successfully deleted | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_entities_analytical_dashboards** +> JsonApiAnalyticalDashboardOutList get_all_entities_analytical_dashboards(workspace_id) + +Get all Dashboards + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import analytical_dashboard_controller_api +from gooddata_api_client.model.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = analytical_dashboard_controller_api.AnalyticalDashboardControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=permissions,origin,accessInfo,page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get all Dashboards + api_response = api_instance.get_all_entities_analytical_dashboards(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AnalyticalDashboardControllerApi->get_all_entities_analytical_dashboards: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Dashboards + api_response = api_instance.get_all_entities_analytical_dashboards(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AnalyticalDashboardControllerApi->get_all_entities_analytical_dashboards: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiAnalyticalDashboardOutList**](JsonApiAnalyticalDashboardOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_analytical_dashboards** +> JsonApiAnalyticalDashboardOutDocument get_entity_analytical_dashboards(workspace_id, object_id) + +Get a Dashboard + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import analytical_dashboard_controller_api +from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = analytical_dashboard_controller_api.AnalyticalDashboardControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=permissions,origin,accessInfo,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a Dashboard + api_response = api_instance.get_entity_analytical_dashboards(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AnalyticalDashboardControllerApi->get_entity_analytical_dashboards: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Dashboard + api_response = api_instance.get_entity_analytical_dashboards(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AnalyticalDashboardControllerApi->get_entity_analytical_dashboards: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiAnalyticalDashboardOutDocument**](JsonApiAnalyticalDashboardOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **patch_entity_analytical_dashboards** +> JsonApiAnalyticalDashboardOutDocument patch_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_patch_document) + +Patch a Dashboard + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import analytical_dashboard_controller_api +from gooddata_api_client.model.json_api_analytical_dashboard_patch_document import JsonApiAnalyticalDashboardPatchDocument +from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = analytical_dashboard_controller_api.AnalyticalDashboardControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_analytical_dashboard_patch_document = JsonApiAnalyticalDashboardPatchDocument( + data=JsonApiAnalyticalDashboardPatch( + attributes=JsonApiAnalyticalDashboardPatchAttributes( + are_relations_valid=True, + content={}, + description="description_example", + summary="summary_example", + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="analyticalDashboard", + ), + ) # JsonApiAnalyticalDashboardPatchDocument | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Patch a Dashboard + api_response = api_instance.patch_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AnalyticalDashboardControllerApi->patch_entity_analytical_dashboards: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch a Dashboard + api_response = api_instance.patch_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AnalyticalDashboardControllerApi->patch_entity_analytical_dashboards: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_analytical_dashboard_patch_document** | [**JsonApiAnalyticalDashboardPatchDocument**](JsonApiAnalyticalDashboardPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiAnalyticalDashboardOutDocument**](JsonApiAnalyticalDashboardOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **search_entities_analytical_dashboards** +> JsonApiAnalyticalDashboardOutList search_entities_analytical_dashboards(workspace_id, entity_search_body) + +The search endpoint (beta) + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import analytical_dashboard_controller_api +from gooddata_api_client.model.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = analytical_dashboard_controller_api.AnalyticalDashboardControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + entity_search_body = EntitySearchBody( + filter="filter_example", + include=[ + "include_example", + ], + meta_include=[ + "meta_include_example", + ], + page=EntitySearchPage( + index=0, + size=100, + ), + sort=[ + EntitySearchSort( + direction="ASC", + _property="_property_example", + ), + ], + ) # EntitySearchBody | Search request body with filter, pagination, and sorting options + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_analytical_dashboards(workspace_id, entity_search_body) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AnalyticalDashboardControllerApi->search_entities_analytical_dashboards: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_analytical_dashboards(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AnalyticalDashboardControllerApi->search_entities_analytical_dashboards: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + +### Return type + +[**JsonApiAnalyticalDashboardOutList**](JsonApiAnalyticalDashboardOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_entity_analytical_dashboards** +> JsonApiAnalyticalDashboardOutDocument update_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_in_document) + +Put Dashboards + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import analytical_dashboard_controller_api +from gooddata_api_client.model.json_api_analytical_dashboard_in_document import JsonApiAnalyticalDashboardInDocument +from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = analytical_dashboard_controller_api.AnalyticalDashboardControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_analytical_dashboard_in_document = JsonApiAnalyticalDashboardInDocument( + data=JsonApiAnalyticalDashboardIn( + attributes=JsonApiAnalyticalDashboardInAttributes( + are_relations_valid=True, + content={}, + description="description_example", + summary="summary_example", + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="analyticalDashboard", + ), + ) # JsonApiAnalyticalDashboardInDocument | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Put Dashboards + api_response = api_instance.update_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AnalyticalDashboardControllerApi->update_entity_analytical_dashboards: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put Dashboards + api_response = api_instance.update_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AnalyticalDashboardControllerApi->update_entity_analytical_dashboards: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_analytical_dashboard_in_document** | [**JsonApiAnalyticalDashboardInDocument**](JsonApiAnalyticalDashboardInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiAnalyticalDashboardOutDocument**](JsonApiAnalyticalDashboardOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/gooddata-api-client/docs/ApiTokenControllerApi.md b/gooddata-api-client/docs/ApiTokenControllerApi.md new file mode 100644 index 000000000..ee8ae5568 --- /dev/null +++ b/gooddata-api-client/docs/ApiTokenControllerApi.md @@ -0,0 +1,326 @@ +# gooddata_api_client.ApiTokenControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_api_tokens**](ApiTokenControllerApi.md#create_entity_api_tokens) | **POST** /api/v1/entities/users/{userId}/apiTokens | Post a new API token for the user +[**delete_entity_api_tokens**](ApiTokenControllerApi.md#delete_entity_api_tokens) | **DELETE** /api/v1/entities/users/{userId}/apiTokens/{id} | Delete an API Token for a user +[**get_all_entities_api_tokens**](ApiTokenControllerApi.md#get_all_entities_api_tokens) | **GET** /api/v1/entities/users/{userId}/apiTokens | List all api tokens for a user +[**get_entity_api_tokens**](ApiTokenControllerApi.md#get_entity_api_tokens) | **GET** /api/v1/entities/users/{userId}/apiTokens/{id} | Get an API Token for a user + + +# **create_entity_api_tokens** +> JsonApiApiTokenOutDocument create_entity_api_tokens(user_id, json_api_api_token_in_document) + +Post a new API token for the user + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import api_token_controller_api +from gooddata_api_client.model.json_api_api_token_out_document import JsonApiApiTokenOutDocument +from gooddata_api_client.model.json_api_api_token_in_document import JsonApiApiTokenInDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = api_token_controller_api.ApiTokenControllerApi(api_client) + user_id = "userId_example" # str | + json_api_api_token_in_document = JsonApiApiTokenInDocument( + data=JsonApiApiTokenIn( + id="id1", + type="apiToken", + ), + ) # JsonApiApiTokenInDocument | + + # example passing only required values which don't have defaults set + try: + # Post a new API token for the user + 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 ApiTokenControllerApi->create_entity_api_tokens: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_id** | **str**| | + **json_api_api_token_in_document** | [**JsonApiApiTokenInDocument**](JsonApiApiTokenInDocument.md)| | + +### Return type + +[**JsonApiApiTokenOutDocument**](JsonApiApiTokenOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_entity_api_tokens** +> delete_entity_api_tokens(user_id, id) + +Delete an API Token for a user + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import api_token_controller_api +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = api_token_controller_api.ApiTokenControllerApi(api_client) + user_id = "userId_example" # str | + id = "/6bUUGjjNSwg0_bs" # str | + filter = "bearerToken==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Delete an API Token for a user + api_instance.delete_entity_api_tokens(user_id, id) + except gooddata_api_client.ApiException as e: + print("Exception when calling ApiTokenControllerApi->delete_entity_api_tokens: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete an API Token for a user + api_instance.delete_entity_api_tokens(user_id, id, filter=filter) + except gooddata_api_client.ApiException as e: + print("Exception when calling ApiTokenControllerApi->delete_entity_api_tokens: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_id** | **str**| | + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successfully deleted | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_entities_api_tokens** +> JsonApiApiTokenOutList get_all_entities_api_tokens(user_id) + +List all api tokens for a user + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import api_token_controller_api +from gooddata_api_client.model.json_api_api_token_out_list import JsonApiApiTokenOutList +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = api_token_controller_api.ApiTokenControllerApi(api_client) + user_id = "userId_example" # str | + filter = "bearerToken==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = [ + "metaInclude=page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # List all api tokens for a user + api_response = api_instance.get_all_entities_api_tokens(user_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ApiTokenControllerApi->get_all_entities_api_tokens: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # List all api tokens for a user + api_response = api_instance.get_all_entities_api_tokens(user_id, filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ApiTokenControllerApi->get_all_entities_api_tokens: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiApiTokenOutList**](JsonApiApiTokenOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_api_tokens** +> JsonApiApiTokenOutDocument get_entity_api_tokens(user_id, id) + +Get an API Token for a user + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import api_token_controller_api +from gooddata_api_client.model.json_api_api_token_out_document import JsonApiApiTokenOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = api_token_controller_api.ApiTokenControllerApi(api_client) + user_id = "userId_example" # str | + id = "/6bUUGjjNSwg0_bs" # str | + filter = "bearerToken==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Get an API Token for a user + api_response = api_instance.get_entity_api_tokens(user_id, id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ApiTokenControllerApi->get_entity_api_tokens: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get an API Token for a user + api_response = api_instance.get_entity_api_tokens(user_id, id, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ApiTokenControllerApi->get_entity_api_tokens: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_id** | **str**| | + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiApiTokenOutDocument**](JsonApiApiTokenOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/gooddata-api-client/docs/AttributeControllerApi.md b/gooddata-api-client/docs/AttributeControllerApi.md new file mode 100644 index 000000000..d07288168 --- /dev/null +++ b/gooddata-api-client/docs/AttributeControllerApi.md @@ -0,0 +1,397 @@ +# gooddata_api_client.AttributeControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_all_entities_attributes**](AttributeControllerApi.md#get_all_entities_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributes | Get all Attributes +[**get_entity_attributes**](AttributeControllerApi.md#get_entity_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId} | Get an Attribute +[**patch_entity_attributes**](AttributeControllerApi.md#patch_entity_attributes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId} | Patch an Attribute (beta) +[**search_entities_attributes**](AttributeControllerApi.md#search_entities_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributes/search | The search endpoint (beta) + + +# **get_all_entities_attributes** +> JsonApiAttributeOutList get_all_entities_attributes(workspace_id) + +Get all Attributes + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import attribute_controller_api +from gooddata_api_client.model.json_api_attribute_out_list import JsonApiAttributeOutList +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = attribute_controller_api.AttributeControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString;dataset.id==321;defaultView.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "dataset,defaultView,labels,attributeHierarchies", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get all Attributes + api_response = api_instance.get_all_entities_attributes(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeControllerApi->get_all_entities_attributes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Attributes + api_response = api_instance.get_all_entities_attributes(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeControllerApi->get_all_entities_attributes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiAttributeOutList**](JsonApiAttributeOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_attributes** +> JsonApiAttributeOutDocument get_entity_attributes(workspace_id, object_id) + +Get an Attribute + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import attribute_controller_api +from gooddata_api_client.model.json_api_attribute_out_document import JsonApiAttributeOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = attribute_controller_api.AttributeControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;dataset.id==321;defaultView.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "dataset,defaultView,labels,attributeHierarchies", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get an Attribute + api_response = api_instance.get_entity_attributes(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeControllerApi->get_entity_attributes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get an Attribute + api_response = api_instance.get_entity_attributes(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeControllerApi->get_entity_attributes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiAttributeOutDocument**](JsonApiAttributeOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **patch_entity_attributes** +> JsonApiAttributeOutDocument patch_entity_attributes(workspace_id, object_id, json_api_attribute_patch_document) + +Patch an Attribute (beta) + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import attribute_controller_api +from gooddata_api_client.model.json_api_attribute_patch_document import JsonApiAttributePatchDocument +from gooddata_api_client.model.json_api_attribute_out_document import JsonApiAttributeOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = attribute_controller_api.AttributeControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_attribute_patch_document = JsonApiAttributePatchDocument( + data=JsonApiAttributePatch( + attributes=JsonApiAttributePatchAttributes( + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + relationships=JsonApiAttributePatchRelationships( + default_view=JsonApiAttributeOutRelationshipsDefaultView( + data=JsonApiLabelToOneLinkage(None), + ), + ), + type="attribute", + ), + ) # JsonApiAttributePatchDocument | + filter = "title==someString;description==someString;dataset.id==321;defaultView.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "dataset,defaultView,labels,attributeHierarchies", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Patch an Attribute (beta) + api_response = api_instance.patch_entity_attributes(workspace_id, object_id, json_api_attribute_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeControllerApi->patch_entity_attributes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch an Attribute (beta) + api_response = api_instance.patch_entity_attributes(workspace_id, object_id, json_api_attribute_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeControllerApi->patch_entity_attributes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_attribute_patch_document** | [**JsonApiAttributePatchDocument**](JsonApiAttributePatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiAttributeOutDocument**](JsonApiAttributeOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **search_entities_attributes** +> JsonApiAttributeOutList search_entities_attributes(workspace_id, entity_search_body) + +The search endpoint (beta) + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import attribute_controller_api +from gooddata_api_client.model.json_api_attribute_out_list import JsonApiAttributeOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = attribute_controller_api.AttributeControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + entity_search_body = EntitySearchBody( + filter="filter_example", + include=[ + "include_example", + ], + meta_include=[ + "meta_include_example", + ], + page=EntitySearchPage( + index=0, + size=100, + ), + sort=[ + EntitySearchSort( + direction="ASC", + _property="_property_example", + ), + ], + ) # EntitySearchBody | Search request body with filter, pagination, and sorting options + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_attributes(workspace_id, entity_search_body) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeControllerApi->search_entities_attributes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_attributes(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeControllerApi->search_entities_attributes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + +### Return type + +[**JsonApiAttributeOutList**](JsonApiAttributeOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/gooddata-api-client/docs/AttributeHierarchiesApi.md b/gooddata-api-client/docs/AttributeHierarchiesApi.md index fc20920b2..dbcdc632d 100644 --- a/gooddata-api-client/docs/AttributeHierarchiesApi.md +++ b/gooddata-api-client/docs/AttributeHierarchiesApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description [**get_all_entities_attribute_hierarchies**](AttributeHierarchiesApi.md#get_all_entities_attribute_hierarchies) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies | Get all Attribute Hierarchies [**get_entity_attribute_hierarchies**](AttributeHierarchiesApi.md#get_entity_attribute_hierarchies) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Get an Attribute Hierarchy [**patch_entity_attribute_hierarchies**](AttributeHierarchiesApi.md#patch_entity_attribute_hierarchies) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Patch an Attribute Hierarchy -[**search_entities_attribute_hierarchies**](AttributeHierarchiesApi.md#search_entities_attribute_hierarchies) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search | Search request for AttributeHierarchy +[**search_entities_attribute_hierarchies**](AttributeHierarchiesApi.md#search_entities_attribute_hierarchies) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search | The search endpoint (beta) [**update_entity_attribute_hierarchies**](AttributeHierarchiesApi.md#update_entity_attribute_hierarchies) | **PUT** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Put an Attribute Hierarchy @@ -473,7 +473,7 @@ No authorization required # **search_entities_attribute_hierarchies** > JsonApiAttributeHierarchyOutList search_entities_attribute_hierarchies(workspace_id, entity_search_body) -Search request for AttributeHierarchy +The search endpoint (beta) ### Example @@ -521,7 +521,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Search request for AttributeHierarchy + # The search endpoint (beta) api_response = api_instance.search_entities_attribute_hierarchies(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -530,7 +530,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Search request for AttributeHierarchy + # The search endpoint (beta) api_response = api_instance.search_entities_attribute_hierarchies(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/AttributeHierarchyControllerApi.md b/gooddata-api-client/docs/AttributeHierarchyControllerApi.md new file mode 100644 index 000000000..f963340f3 --- /dev/null +++ b/gooddata-api-client/docs/AttributeHierarchyControllerApi.md @@ -0,0 +1,670 @@ +# gooddata_api_client.AttributeHierarchyControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_attribute_hierarchies**](AttributeHierarchyControllerApi.md#create_entity_attribute_hierarchies) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies | Post Attribute Hierarchies +[**delete_entity_attribute_hierarchies**](AttributeHierarchyControllerApi.md#delete_entity_attribute_hierarchies) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Delete an Attribute Hierarchy +[**get_all_entities_attribute_hierarchies**](AttributeHierarchyControllerApi.md#get_all_entities_attribute_hierarchies) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies | Get all Attribute Hierarchies +[**get_entity_attribute_hierarchies**](AttributeHierarchyControllerApi.md#get_entity_attribute_hierarchies) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Get an Attribute Hierarchy +[**patch_entity_attribute_hierarchies**](AttributeHierarchyControllerApi.md#patch_entity_attribute_hierarchies) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Patch an Attribute Hierarchy +[**search_entities_attribute_hierarchies**](AttributeHierarchyControllerApi.md#search_entities_attribute_hierarchies) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search | The search endpoint (beta) +[**update_entity_attribute_hierarchies**](AttributeHierarchyControllerApi.md#update_entity_attribute_hierarchies) | **PUT** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Put an Attribute Hierarchy + + +# **create_entity_attribute_hierarchies** +> JsonApiAttributeHierarchyOutDocument create_entity_attribute_hierarchies(workspace_id, json_api_attribute_hierarchy_in_document) + +Post Attribute Hierarchies + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import attribute_hierarchy_controller_api +from gooddata_api_client.model.json_api_attribute_hierarchy_in_document import JsonApiAttributeHierarchyInDocument +from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = attribute_hierarchy_controller_api.AttributeHierarchyControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + json_api_attribute_hierarchy_in_document = JsonApiAttributeHierarchyInDocument( + data=JsonApiAttributeHierarchyIn( + attributes=JsonApiAttributeHierarchyInAttributes( + are_relations_valid=True, + content={}, + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="attributeHierarchy", + ), + ) # JsonApiAttributeHierarchyInDocument | + include = [ + "createdBy,modifiedBy,attributes", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Attribute Hierarchies + api_response = api_instance.create_entity_attribute_hierarchies(workspace_id, json_api_attribute_hierarchy_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeHierarchyControllerApi->create_entity_attribute_hierarchies: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Attribute Hierarchies + api_response = api_instance.create_entity_attribute_hierarchies(workspace_id, json_api_attribute_hierarchy_in_document, include=include, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeHierarchyControllerApi->create_entity_attribute_hierarchies: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_attribute_hierarchy_in_document** | [**JsonApiAttributeHierarchyInDocument**](JsonApiAttributeHierarchyInDocument.md)| | + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiAttributeHierarchyOutDocument**](JsonApiAttributeHierarchyOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_entity_attribute_hierarchies** +> delete_entity_attribute_hierarchies(workspace_id, object_id) + +Delete an Attribute Hierarchy + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import attribute_hierarchy_controller_api +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = attribute_hierarchy_controller_api.AttributeHierarchyControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Delete an Attribute Hierarchy + api_instance.delete_entity_attribute_hierarchies(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeHierarchyControllerApi->delete_entity_attribute_hierarchies: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete an Attribute Hierarchy + api_instance.delete_entity_attribute_hierarchies(workspace_id, object_id, filter=filter) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeHierarchyControllerApi->delete_entity_attribute_hierarchies: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successfully deleted | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_entities_attribute_hierarchies** +> JsonApiAttributeHierarchyOutList get_all_entities_attribute_hierarchies(workspace_id) + +Get all Attribute Hierarchies + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import attribute_hierarchy_controller_api +from gooddata_api_client.model.json_api_attribute_hierarchy_out_list import JsonApiAttributeHierarchyOutList +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = attribute_hierarchy_controller_api.AttributeHierarchyControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,attributes", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get all Attribute Hierarchies + api_response = api_instance.get_all_entities_attribute_hierarchies(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeHierarchyControllerApi->get_all_entities_attribute_hierarchies: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Attribute Hierarchies + api_response = api_instance.get_all_entities_attribute_hierarchies(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeHierarchyControllerApi->get_all_entities_attribute_hierarchies: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiAttributeHierarchyOutList**](JsonApiAttributeHierarchyOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_attribute_hierarchies** +> JsonApiAttributeHierarchyOutDocument get_entity_attribute_hierarchies(workspace_id, object_id) + +Get an Attribute Hierarchy + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import attribute_hierarchy_controller_api +from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = attribute_hierarchy_controller_api.AttributeHierarchyControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,attributes", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get an Attribute Hierarchy + api_response = api_instance.get_entity_attribute_hierarchies(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeHierarchyControllerApi->get_entity_attribute_hierarchies: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get an Attribute Hierarchy + api_response = api_instance.get_entity_attribute_hierarchies(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeHierarchyControllerApi->get_entity_attribute_hierarchies: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiAttributeHierarchyOutDocument**](JsonApiAttributeHierarchyOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **patch_entity_attribute_hierarchies** +> JsonApiAttributeHierarchyOutDocument patch_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_patch_document) + +Patch an Attribute Hierarchy + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import attribute_hierarchy_controller_api +from gooddata_api_client.model.json_api_attribute_hierarchy_patch_document import JsonApiAttributeHierarchyPatchDocument +from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = attribute_hierarchy_controller_api.AttributeHierarchyControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_attribute_hierarchy_patch_document = JsonApiAttributeHierarchyPatchDocument( + data=JsonApiAttributeHierarchyPatch( + attributes=JsonApiAttributeHierarchyInAttributes( + are_relations_valid=True, + content={}, + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="attributeHierarchy", + ), + ) # JsonApiAttributeHierarchyPatchDocument | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,attributes", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Patch an Attribute Hierarchy + api_response = api_instance.patch_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeHierarchyControllerApi->patch_entity_attribute_hierarchies: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch an Attribute Hierarchy + api_response = api_instance.patch_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeHierarchyControllerApi->patch_entity_attribute_hierarchies: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_attribute_hierarchy_patch_document** | [**JsonApiAttributeHierarchyPatchDocument**](JsonApiAttributeHierarchyPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiAttributeHierarchyOutDocument**](JsonApiAttributeHierarchyOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **search_entities_attribute_hierarchies** +> JsonApiAttributeHierarchyOutList search_entities_attribute_hierarchies(workspace_id, entity_search_body) + +The search endpoint (beta) + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import attribute_hierarchy_controller_api +from gooddata_api_client.model.json_api_attribute_hierarchy_out_list import JsonApiAttributeHierarchyOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = attribute_hierarchy_controller_api.AttributeHierarchyControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + entity_search_body = EntitySearchBody( + filter="filter_example", + include=[ + "include_example", + ], + meta_include=[ + "meta_include_example", + ], + page=EntitySearchPage( + index=0, + size=100, + ), + sort=[ + EntitySearchSort( + direction="ASC", + _property="_property_example", + ), + ], + ) # EntitySearchBody | Search request body with filter, pagination, and sorting options + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_attribute_hierarchies(workspace_id, entity_search_body) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeHierarchyControllerApi->search_entities_attribute_hierarchies: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_attribute_hierarchies(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeHierarchyControllerApi->search_entities_attribute_hierarchies: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + +### Return type + +[**JsonApiAttributeHierarchyOutList**](JsonApiAttributeHierarchyOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_entity_attribute_hierarchies** +> JsonApiAttributeHierarchyOutDocument update_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_in_document) + +Put an Attribute Hierarchy + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import attribute_hierarchy_controller_api +from gooddata_api_client.model.json_api_attribute_hierarchy_in_document import JsonApiAttributeHierarchyInDocument +from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = attribute_hierarchy_controller_api.AttributeHierarchyControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_attribute_hierarchy_in_document = JsonApiAttributeHierarchyInDocument( + data=JsonApiAttributeHierarchyIn( + attributes=JsonApiAttributeHierarchyInAttributes( + are_relations_valid=True, + content={}, + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="attributeHierarchy", + ), + ) # JsonApiAttributeHierarchyInDocument | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,attributes", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Put an Attribute Hierarchy + api_response = api_instance.update_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeHierarchyControllerApi->update_entity_attribute_hierarchies: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put an Attribute Hierarchy + api_response = api_instance.update_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeHierarchyControllerApi->update_entity_attribute_hierarchies: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_attribute_hierarchy_in_document** | [**JsonApiAttributeHierarchyInDocument**](JsonApiAttributeHierarchyInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiAttributeHierarchyOutDocument**](JsonApiAttributeHierarchyOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/gooddata-api-client/docs/AttributesApi.md b/gooddata-api-client/docs/AttributesApi.md index 665612bc8..2e606687c 100644 --- a/gooddata-api-client/docs/AttributesApi.md +++ b/gooddata-api-client/docs/AttributesApi.md @@ -7,7 +7,7 @@ Method | HTTP request | Description [**get_all_entities_attributes**](AttributesApi.md#get_all_entities_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributes | Get all Attributes [**get_entity_attributes**](AttributesApi.md#get_entity_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId} | Get an Attribute [**patch_entity_attributes**](AttributesApi.md#patch_entity_attributes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId} | Patch an Attribute (beta) -[**search_entities_attributes**](AttributesApi.md#search_entities_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributes/search | Search request for Attribute +[**search_entities_attributes**](AttributesApi.md#search_entities_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributes/search | The search endpoint (beta) # **get_all_entities_attributes** @@ -299,7 +299,7 @@ No authorization required # **search_entities_attributes** > JsonApiAttributeOutList search_entities_attributes(workspace_id, entity_search_body) -Search request for Attribute +The search endpoint (beta) ### Example @@ -347,7 +347,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Search request for Attribute + # The search endpoint (beta) api_response = api_instance.search_entities_attributes(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -356,7 +356,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Search request for Attribute + # The search endpoint (beta) api_response = api_instance.search_entities_attributes(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/AutomationControllerApi.md b/gooddata-api-client/docs/AutomationControllerApi.md new file mode 100644 index 000000000..b569d9d9d --- /dev/null +++ b/gooddata-api-client/docs/AutomationControllerApi.md @@ -0,0 +1,1441 @@ +# gooddata_api_client.AutomationControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_automations**](AutomationControllerApi.md#create_entity_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations | Post Automations +[**delete_entity_automations**](AutomationControllerApi.md#delete_entity_automations) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Delete an Automation +[**get_all_entities_automations**](AutomationControllerApi.md#get_all_entities_automations) | **GET** /api/v1/entities/workspaces/{workspaceId}/automations | Get all Automations +[**get_entity_automations**](AutomationControllerApi.md#get_entity_automations) | **GET** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Get an Automation +[**patch_entity_automations**](AutomationControllerApi.md#patch_entity_automations) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Patch an Automation +[**search_entities_automations**](AutomationControllerApi.md#search_entities_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations/search | The search endpoint (beta) +[**update_entity_automations**](AutomationControllerApi.md#update_entity_automations) | **PUT** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Put an Automation + + +# **create_entity_automations** +> JsonApiAutomationOutDocument create_entity_automations(workspace_id, json_api_automation_in_document) + +Post Automations + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import automation_controller_api +from gooddata_api_client.model.json_api_automation_in_document import JsonApiAutomationInDocument +from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = automation_controller_api.AutomationControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + json_api_automation_in_document = JsonApiAutomationInDocument( + data=JsonApiAutomationIn( + attributes=JsonApiAutomationInAttributes( + alert=JsonApiAutomationInAttributesAlert( + condition=AlertCondition(), + execution=AlertAfm( + attributes=[ + AttributeItem( + label=AfmObjectIdentifierLabel( + identifier=AfmObjectIdentifierLabelIdentifier( + id="sample_item.price", + type="label", + ), + ), + local_identifier="attribute_1", + show_all_values=False, + ), + ], + aux_measures=[ + MeasureItem( + definition=MeasureDefinition(), + local_identifier="metric_1", + ), + ], + filters=[ + FilterDefinition(), + ], + measures=[ + MeasureItem( + definition=MeasureDefinition(), + local_identifier="metric_1", + ), + ], + ), + interval="DAY", + trigger="ALWAYS", + ), + are_relations_valid=True, + dashboard_tabular_exports=[ + JsonApiAutomationInAttributesDashboardTabularExportsInner( + request_payload=DashboardTabularExportRequestV2( + dashboard_filters_override=[ + DashboardFilter(), + ], + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + dashboard_tabs_filters_overrides={ + "key": [ + DashboardFilter(), + ], + }, + file_name="result", + format="XLSX", + settings=DashboardExportSettings( + export_info=True, + merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", + ), + widget_ids=[ + "widget_ids_example", + ], + ), + ), + ], + description="description_example", + details={}, + evaluation_mode="SHARED", + external_recipients=[ + JsonApiAutomationInAttributesExternalRecipientsInner( + email="email_example", + ), + ], + image_exports=[ + JsonApiAutomationInAttributesImageExportsInner( + request_payload=ImageExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + format="PNG", + metadata=JsonNode(), + widget_ids=[ + "widget_ids_example", + ], + ), + ), + ], + metadata=JsonApiAutomationInAttributesMetadata(), + raw_exports=[ + JsonApiAutomationInAttributesRawExportsInner( + request_payload=RawExportAutomationRequest( + custom_override=RawCustomOverride( + labels={ + "key": RawCustomLabel( + title="title_example", + ), + }, + metrics={ + "key": RawCustomMetric( + title="title_example", + ), + }, + ), + delimiter="U", + execution=AFM( + attributes=[ + AttributeItem( + label=AfmObjectIdentifierLabel( + identifier=AfmObjectIdentifierLabelIdentifier( + id="sample_item.price", + type="label", + ), + ), + local_identifier="attribute_1", + show_all_values=False, + ), + ], + aux_measures=[ + MeasureItem( + definition=MeasureDefinition(), + local_identifier="metric_1", + ), + ], + filters=[ + FilterDefinition(), + ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=InlineMeasureDefinitionInline( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=AfmObjectIdentifierCoreIdentifier( + id="sample_item.price", + type="attribute", + ), + ), + ), + ], + measures=[ + MeasureItem( + definition=MeasureDefinition(), + local_identifier="metric_1", + ), + ], + ), + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + ), + file_name="result", + format="CSV", + metadata=JsonNode(), + ), + ), + ], + schedule=JsonApiAutomationInAttributesSchedule( + cron="0 */30 9-17 ? * MON-FRI", + first_run=dateutil_parser('2025-01-01T12:00:00Z'), + timezone="Europe/Prague", + ), + slides_exports=[ + JsonApiAutomationInAttributesSlidesExportsInner( + request_payload=SlidesExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + format="PDF", + metadata=JsonNode(), + template_id="template_id_example", + visualization_ids=[ + "visualization_ids_example", + ], + widget_ids=[ + "widget_ids_example", + ], + ), + ), + ], + state="ACTIVE", + tabular_exports=[ + JsonApiAutomationInAttributesTabularExportsInner( + request_payload=TabularExportRequest( + custom_override=CustomOverride( + labels={ + "key": CustomLabel( + title="title_example", + ), + }, + metrics={ + "key": CustomMetric( + format="format_example", + title="title_example", + ), + }, + ), + execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + file_name="result", + format="CSV", + metadata=JsonNode(), + related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + settings=Settings( + delimiter="U", + export_info=True, + grand_totals_position="pinnedBottom", + merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", + pdf_page_size="a4 landscape", + pdf_table_style=[ + PdfTableStyle( + properties=[ + PdfTableStyleProperty( + key="key_example", + value="value_example", + ), + ], + selector="selector_example", + ), + ], + pdf_top_left_content="Good", + pdf_top_right_content="Morning", + show_filters=False, + ), + visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", + visualization_object_custom_filters=[ + {}, + ], + ), + ), + ], + tags=[ + "tags_example", + ], + title="title_example", + visual_exports=[ + JsonApiAutomationInAttributesVisualExportsInner( + request_payload=VisualExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + metadata={}, + ), + ), + ], + ), + id="id1", + relationships=JsonApiAutomationInRelationships( + analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + export_definitions=JsonApiAutomationInRelationshipsExportDefinitions( + data=JsonApiExportDefinitionToManyLinkage([ + JsonApiExportDefinitionLinkage( + id="id_example", + type="exportDefinition", + ), + ]), + ), + notification_channel=JsonApiAutomationInRelationshipsNotificationChannel( + data=JsonApiNotificationChannelToOneLinkage(None), + ), + recipients=JsonApiAutomationInRelationshipsRecipients( + data=JsonApiUserToManyLinkage([ + JsonApiUserLinkage( + id="id_example", + type="user", + ), + ]), + ), + ), + type="automation", + ), + ) # JsonApiAutomationInDocument | + include = [ + "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Automations + api_response = api_instance.create_entity_automations(workspace_id, json_api_automation_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationControllerApi->create_entity_automations: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Automations + api_response = api_instance.create_entity_automations(workspace_id, json_api_automation_in_document, include=include, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationControllerApi->create_entity_automations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_automation_in_document** | [**JsonApiAutomationInDocument**](JsonApiAutomationInDocument.md)| | + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiAutomationOutDocument**](JsonApiAutomationOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_entity_automations** +> delete_entity_automations(workspace_id, object_id) + +Delete an Automation + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import automation_controller_api +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = automation_controller_api.AutomationControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Delete an Automation + api_instance.delete_entity_automations(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationControllerApi->delete_entity_automations: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete an Automation + api_instance.delete_entity_automations(workspace_id, object_id, filter=filter) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationControllerApi->delete_entity_automations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successfully deleted | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_entities_automations** +> JsonApiAutomationOutList get_all_entities_automations(workspace_id) + +Get all Automations + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import automation_controller_api +from gooddata_api_client.model.json_api_automation_out_list import JsonApiAutomationOutList +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = automation_controller_api.AutomationControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get all Automations + api_response = api_instance.get_all_entities_automations(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationControllerApi->get_all_entities_automations: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Automations + api_response = api_instance.get_all_entities_automations(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationControllerApi->get_all_entities_automations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiAutomationOutList**](JsonApiAutomationOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_automations** +> JsonApiAutomationOutDocument get_entity_automations(workspace_id, object_id) + +Get an Automation + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import automation_controller_api +from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = automation_controller_api.AutomationControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get an Automation + api_response = api_instance.get_entity_automations(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationControllerApi->get_entity_automations: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get an Automation + api_response = api_instance.get_entity_automations(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationControllerApi->get_entity_automations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiAutomationOutDocument**](JsonApiAutomationOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **patch_entity_automations** +> JsonApiAutomationOutDocument patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document) + +Patch an Automation + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import automation_controller_api +from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument +from gooddata_api_client.model.json_api_automation_patch_document import JsonApiAutomationPatchDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = automation_controller_api.AutomationControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_automation_patch_document = JsonApiAutomationPatchDocument( + data=JsonApiAutomationPatch( + attributes=JsonApiAutomationInAttributes( + alert=JsonApiAutomationInAttributesAlert( + condition=AlertCondition(), + execution=AlertAfm( + attributes=[ + AttributeItem( + label=AfmObjectIdentifierLabel( + identifier=AfmObjectIdentifierLabelIdentifier( + id="sample_item.price", + type="label", + ), + ), + local_identifier="attribute_1", + show_all_values=False, + ), + ], + aux_measures=[ + MeasureItem( + definition=MeasureDefinition(), + local_identifier="metric_1", + ), + ], + filters=[ + FilterDefinition(), + ], + measures=[ + MeasureItem( + definition=MeasureDefinition(), + local_identifier="metric_1", + ), + ], + ), + interval="DAY", + trigger="ALWAYS", + ), + are_relations_valid=True, + dashboard_tabular_exports=[ + JsonApiAutomationInAttributesDashboardTabularExportsInner( + request_payload=DashboardTabularExportRequestV2( + dashboard_filters_override=[ + DashboardFilter(), + ], + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + dashboard_tabs_filters_overrides={ + "key": [ + DashboardFilter(), + ], + }, + file_name="result", + format="XLSX", + settings=DashboardExportSettings( + export_info=True, + merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", + ), + widget_ids=[ + "widget_ids_example", + ], + ), + ), + ], + description="description_example", + details={}, + evaluation_mode="SHARED", + external_recipients=[ + JsonApiAutomationInAttributesExternalRecipientsInner( + email="email_example", + ), + ], + image_exports=[ + JsonApiAutomationInAttributesImageExportsInner( + request_payload=ImageExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + format="PNG", + metadata=JsonNode(), + widget_ids=[ + "widget_ids_example", + ], + ), + ), + ], + metadata=JsonApiAutomationInAttributesMetadata(), + raw_exports=[ + JsonApiAutomationInAttributesRawExportsInner( + request_payload=RawExportAutomationRequest( + custom_override=RawCustomOverride( + labels={ + "key": RawCustomLabel( + title="title_example", + ), + }, + metrics={ + "key": RawCustomMetric( + title="title_example", + ), + }, + ), + delimiter="U", + execution=AFM( + attributes=[ + AttributeItem( + label=AfmObjectIdentifierLabel( + identifier=AfmObjectIdentifierLabelIdentifier( + id="sample_item.price", + type="label", + ), + ), + local_identifier="attribute_1", + show_all_values=False, + ), + ], + aux_measures=[ + MeasureItem( + definition=MeasureDefinition(), + local_identifier="metric_1", + ), + ], + filters=[ + FilterDefinition(), + ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=InlineMeasureDefinitionInline( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=AfmObjectIdentifierCoreIdentifier( + id="sample_item.price", + type="attribute", + ), + ), + ), + ], + measures=[ + MeasureItem( + definition=MeasureDefinition(), + local_identifier="metric_1", + ), + ], + ), + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + ), + file_name="result", + format="CSV", + metadata=JsonNode(), + ), + ), + ], + schedule=JsonApiAutomationInAttributesSchedule( + cron="0 */30 9-17 ? * MON-FRI", + first_run=dateutil_parser('2025-01-01T12:00:00Z'), + timezone="Europe/Prague", + ), + slides_exports=[ + JsonApiAutomationInAttributesSlidesExportsInner( + request_payload=SlidesExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + format="PDF", + metadata=JsonNode(), + template_id="template_id_example", + visualization_ids=[ + "visualization_ids_example", + ], + widget_ids=[ + "widget_ids_example", + ], + ), + ), + ], + state="ACTIVE", + tabular_exports=[ + JsonApiAutomationInAttributesTabularExportsInner( + request_payload=TabularExportRequest( + custom_override=CustomOverride( + labels={ + "key": CustomLabel( + title="title_example", + ), + }, + metrics={ + "key": CustomMetric( + format="format_example", + title="title_example", + ), + }, + ), + execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + file_name="result", + format="CSV", + metadata=JsonNode(), + related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + settings=Settings( + delimiter="U", + export_info=True, + grand_totals_position="pinnedBottom", + merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", + pdf_page_size="a4 landscape", + pdf_table_style=[ + PdfTableStyle( + properties=[ + PdfTableStyleProperty( + key="key_example", + value="value_example", + ), + ], + selector="selector_example", + ), + ], + pdf_top_left_content="Good", + pdf_top_right_content="Morning", + show_filters=False, + ), + visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", + visualization_object_custom_filters=[ + {}, + ], + ), + ), + ], + tags=[ + "tags_example", + ], + title="title_example", + visual_exports=[ + JsonApiAutomationInAttributesVisualExportsInner( + request_payload=VisualExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + metadata={}, + ), + ), + ], + ), + id="id1", + relationships=JsonApiAutomationInRelationships( + analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + export_definitions=JsonApiAutomationInRelationshipsExportDefinitions( + data=JsonApiExportDefinitionToManyLinkage([ + JsonApiExportDefinitionLinkage( + id="id_example", + type="exportDefinition", + ), + ]), + ), + notification_channel=JsonApiAutomationInRelationshipsNotificationChannel( + data=JsonApiNotificationChannelToOneLinkage(None), + ), + recipients=JsonApiAutomationInRelationshipsRecipients( + data=JsonApiUserToManyLinkage([ + JsonApiUserLinkage( + id="id_example", + type="user", + ), + ]), + ), + ), + type="automation", + ), + ) # JsonApiAutomationPatchDocument | + filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Patch an Automation + api_response = api_instance.patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationControllerApi->patch_entity_automations: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch an Automation + api_response = api_instance.patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationControllerApi->patch_entity_automations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_automation_patch_document** | [**JsonApiAutomationPatchDocument**](JsonApiAutomationPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiAutomationOutDocument**](JsonApiAutomationOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **search_entities_automations** +> JsonApiAutomationOutList search_entities_automations(workspace_id, entity_search_body) + +The search endpoint (beta) + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import automation_controller_api +from gooddata_api_client.model.json_api_automation_out_list import JsonApiAutomationOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = automation_controller_api.AutomationControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + entity_search_body = EntitySearchBody( + filter="filter_example", + include=[ + "include_example", + ], + meta_include=[ + "meta_include_example", + ], + page=EntitySearchPage( + index=0, + size=100, + ), + sort=[ + EntitySearchSort( + direction="ASC", + _property="_property_example", + ), + ], + ) # EntitySearchBody | Search request body with filter, pagination, and sorting options + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_automations(workspace_id, entity_search_body) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationControllerApi->search_entities_automations: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_automations(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationControllerApi->search_entities_automations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + +### Return type + +[**JsonApiAutomationOutList**](JsonApiAutomationOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_entity_automations** +> JsonApiAutomationOutDocument update_entity_automations(workspace_id, object_id, json_api_automation_in_document) + +Put an Automation + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import automation_controller_api +from gooddata_api_client.model.json_api_automation_in_document import JsonApiAutomationInDocument +from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = automation_controller_api.AutomationControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_automation_in_document = JsonApiAutomationInDocument( + data=JsonApiAutomationIn( + attributes=JsonApiAutomationInAttributes( + alert=JsonApiAutomationInAttributesAlert( + condition=AlertCondition(), + execution=AlertAfm( + attributes=[ + AttributeItem( + label=AfmObjectIdentifierLabel( + identifier=AfmObjectIdentifierLabelIdentifier( + id="sample_item.price", + type="label", + ), + ), + local_identifier="attribute_1", + show_all_values=False, + ), + ], + aux_measures=[ + MeasureItem( + definition=MeasureDefinition(), + local_identifier="metric_1", + ), + ], + filters=[ + FilterDefinition(), + ], + measures=[ + MeasureItem( + definition=MeasureDefinition(), + local_identifier="metric_1", + ), + ], + ), + interval="DAY", + trigger="ALWAYS", + ), + are_relations_valid=True, + dashboard_tabular_exports=[ + JsonApiAutomationInAttributesDashboardTabularExportsInner( + request_payload=DashboardTabularExportRequestV2( + dashboard_filters_override=[ + DashboardFilter(), + ], + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + dashboard_tabs_filters_overrides={ + "key": [ + DashboardFilter(), + ], + }, + file_name="result", + format="XLSX", + settings=DashboardExportSettings( + export_info=True, + merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", + ), + widget_ids=[ + "widget_ids_example", + ], + ), + ), + ], + description="description_example", + details={}, + evaluation_mode="SHARED", + external_recipients=[ + JsonApiAutomationInAttributesExternalRecipientsInner( + email="email_example", + ), + ], + image_exports=[ + JsonApiAutomationInAttributesImageExportsInner( + request_payload=ImageExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + format="PNG", + metadata=JsonNode(), + widget_ids=[ + "widget_ids_example", + ], + ), + ), + ], + metadata=JsonApiAutomationInAttributesMetadata(), + raw_exports=[ + JsonApiAutomationInAttributesRawExportsInner( + request_payload=RawExportAutomationRequest( + custom_override=RawCustomOverride( + labels={ + "key": RawCustomLabel( + title="title_example", + ), + }, + metrics={ + "key": RawCustomMetric( + title="title_example", + ), + }, + ), + delimiter="U", + execution=AFM( + attributes=[ + AttributeItem( + label=AfmObjectIdentifierLabel( + identifier=AfmObjectIdentifierLabelIdentifier( + id="sample_item.price", + type="label", + ), + ), + local_identifier="attribute_1", + show_all_values=False, + ), + ], + aux_measures=[ + MeasureItem( + definition=MeasureDefinition(), + local_identifier="metric_1", + ), + ], + filters=[ + FilterDefinition(), + ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=InlineMeasureDefinitionInline( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=AfmObjectIdentifierCoreIdentifier( + id="sample_item.price", + type="attribute", + ), + ), + ), + ], + measures=[ + MeasureItem( + definition=MeasureDefinition(), + local_identifier="metric_1", + ), + ], + ), + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + ), + file_name="result", + format="CSV", + metadata=JsonNode(), + ), + ), + ], + schedule=JsonApiAutomationInAttributesSchedule( + cron="0 */30 9-17 ? * MON-FRI", + first_run=dateutil_parser('2025-01-01T12:00:00Z'), + timezone="Europe/Prague", + ), + slides_exports=[ + JsonApiAutomationInAttributesSlidesExportsInner( + request_payload=SlidesExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + format="PDF", + metadata=JsonNode(), + template_id="template_id_example", + visualization_ids=[ + "visualization_ids_example", + ], + widget_ids=[ + "widget_ids_example", + ], + ), + ), + ], + state="ACTIVE", + tabular_exports=[ + JsonApiAutomationInAttributesTabularExportsInner( + request_payload=TabularExportRequest( + custom_override=CustomOverride( + labels={ + "key": CustomLabel( + title="title_example", + ), + }, + metrics={ + "key": CustomMetric( + format="format_example", + title="title_example", + ), + }, + ), + execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + file_name="result", + format="CSV", + metadata=JsonNode(), + related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + settings=Settings( + delimiter="U", + export_info=True, + grand_totals_position="pinnedBottom", + merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", + pdf_page_size="a4 landscape", + pdf_table_style=[ + PdfTableStyle( + properties=[ + PdfTableStyleProperty( + key="key_example", + value="value_example", + ), + ], + selector="selector_example", + ), + ], + pdf_top_left_content="Good", + pdf_top_right_content="Morning", + show_filters=False, + ), + visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", + visualization_object_custom_filters=[ + {}, + ], + ), + ), + ], + tags=[ + "tags_example", + ], + title="title_example", + visual_exports=[ + JsonApiAutomationInAttributesVisualExportsInner( + request_payload=VisualExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + metadata={}, + ), + ), + ], + ), + id="id1", + relationships=JsonApiAutomationInRelationships( + analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + export_definitions=JsonApiAutomationInRelationshipsExportDefinitions( + data=JsonApiExportDefinitionToManyLinkage([ + JsonApiExportDefinitionLinkage( + id="id_example", + type="exportDefinition", + ), + ]), + ), + notification_channel=JsonApiAutomationInRelationshipsNotificationChannel( + data=JsonApiNotificationChannelToOneLinkage(None), + ), + recipients=JsonApiAutomationInRelationshipsRecipients( + data=JsonApiUserToManyLinkage([ + JsonApiUserLinkage( + id="id_example", + type="user", + ), + ]), + ), + ), + type="automation", + ), + ) # JsonApiAutomationInDocument | + filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Put an Automation + api_response = api_instance.update_entity_automations(workspace_id, object_id, json_api_automation_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationControllerApi->update_entity_automations: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put an Automation + api_response = api_instance.update_entity_automations(workspace_id, object_id, json_api_automation_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationControllerApi->update_entity_automations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_automation_in_document** | [**JsonApiAutomationInDocument**](JsonApiAutomationInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiAutomationOutDocument**](JsonApiAutomationOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/gooddata-api-client/docs/AutomationsApi.md b/gooddata-api-client/docs/AutomationsApi.md index c569e36b5..bf68d02f9 100644 --- a/gooddata-api-client/docs/AutomationsApi.md +++ b/gooddata-api-client/docs/AutomationsApi.md @@ -16,7 +16,7 @@ Method | HTTP request | Description [**pause_organization_automations**](AutomationsApi.md#pause_organization_automations) | **POST** /api/v1/actions/organization/automations/pause | Pause selected automations across all workspaces [**pause_workspace_automations**](AutomationsApi.md#pause_workspace_automations) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/pause | Pause selected automations in the workspace [**search_entities_automation_results**](AutomationsApi.md#search_entities_automation_results) | **POST** /api/v1/entities/workspaces/{workspaceId}/automationResults/search | Search request for AutomationResult -[**search_entities_automations**](AutomationsApi.md#search_entities_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations/search | Search request for Automation +[**search_entities_automations**](AutomationsApi.md#search_entities_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations/search | The search endpoint (beta) [**set_automations**](AutomationsApi.md#set_automations) | **PUT** /api/v1/layout/workspaces/{workspaceId}/automations | Set automations [**trigger_automation**](AutomationsApi.md#trigger_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/trigger | Trigger automation. [**trigger_existing_automation**](AutomationsApi.md#trigger_existing_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/trigger | Trigger existing automation. @@ -260,6 +260,7 @@ with gooddata_api_client.ApiClient() as api_client: settings=Settings( delimiter="U", export_info=True, + grand_totals_position="pinnedBottom", merge_headers=True, page_orientation="PORTRAIT", page_size="A4", @@ -1180,6 +1181,7 @@ with gooddata_api_client.ApiClient() as api_client: settings=Settings( delimiter="U", export_info=True, + grand_totals_position="pinnedBottom", merge_headers=True, page_orientation="PORTRAIT", page_size="A4", @@ -1549,7 +1551,7 @@ No authorization required # **search_entities_automations** > JsonApiAutomationOutList search_entities_automations(workspace_id, entity_search_body) -Search request for Automation +The search endpoint (beta) ### Example @@ -1597,7 +1599,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Search request for Automation + # The search endpoint (beta) api_response = api_instance.search_entities_automations(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -1606,7 +1608,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Search request for Automation + # The search endpoint (beta) api_response = api_instance.search_entities_automations(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -1907,6 +1909,7 @@ with gooddata_api_client.ApiClient() as api_client: settings=Settings( delimiter="U", export_info=True, + grand_totals_position="pinnedBottom", merge_headers=True, page_orientation="PORTRAIT", page_size="A4", @@ -2225,6 +2228,7 @@ with gooddata_api_client.ApiClient() as api_client: settings=Settings( delimiter="U", export_info=True, + grand_totals_position="pinnedBottom", merge_headers=True, page_orientation="PORTRAIT", page_size="A4", @@ -3074,6 +3078,7 @@ with gooddata_api_client.ApiClient() as api_client: settings=Settings( delimiter="U", export_info=True, + grand_totals_position="pinnedBottom", merge_headers=True, page_orientation="PORTRAIT", page_size="A4", diff --git a/gooddata-api-client/docs/AzureFoundryProviderConfig.md b/gooddata-api-client/docs/AzureFoundryProviderConfig.md index 08a6da0b6..5bc986efa 100644 --- a/gooddata-api-client/docs/AzureFoundryProviderConfig.md +++ b/gooddata-api-client/docs/AzureFoundryProviderConfig.md @@ -6,7 +6,7 @@ Configuration for Azure Foundry provider. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **auth** | [**AzureFoundryProviderAuth**](AzureFoundryProviderAuth.md) | | -**endpoint** | **str** | Azure AI inference endpoint URL. | +**endpoint** | **str** | Azure OpenAI endpoint URL. | **type** | **str** | Provider type. | defaults to "AZURE_FOUNDRY" **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/gooddata-api-client/docs/ComputationApi.md b/gooddata-api-client/docs/ComputationApi.md index e68210423..c53b64dc6 100644 --- a/gooddata-api-client/docs/ComputationApi.md +++ b/gooddata-api-client/docs/ComputationApi.md @@ -1414,7 +1414,7 @@ No authorization required Get a single execution result -Gets a single execution result. +Gets a single execution result. Note that the Arrow File and Arrow Stream content types are currently in BETA. ### Example @@ -1438,6 +1438,7 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = computation_api.ComputationApi(api_client) workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier result_id = "a9b28f9dc55f37ea9f4a5fb0c76895923591e781" # str | Result ID + x_gdc_cancel_token = "X-GDC-CANCEL-TOKEN_example" # str | (optional) offset = [ offset=1,10, ] # [int] | Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM. (optional) if omitted the server will use the default value of [] @@ -1447,7 +1448,6 @@ with gooddata_api_client.ApiClient() as api_client: excluded_total_dimensions = [ "excludedTotalDimensions=dim_0,dim_1", ] # [str] | Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions. (optional) if omitted the server will use the default value of [] - x_gdc_cancel_token = "X-GDC-CANCEL-TOKEN_example" # str | (optional) # example passing only required values which don't have defaults set try: @@ -1461,7 +1461,7 @@ with gooddata_api_client.ApiClient() as api_client: # and optional values try: # Get a single execution result - api_response = api_instance.retrieve_result(workspace_id, result_id, offset=offset, limit=limit, excluded_total_dimensions=excluded_total_dimensions, x_gdc_cancel_token=x_gdc_cancel_token) + api_response = api_instance.retrieve_result(workspace_id, result_id, x_gdc_cancel_token=x_gdc_cancel_token, offset=offset, limit=limit, excluded_total_dimensions=excluded_total_dimensions) pprint(api_response) except gooddata_api_client.ApiException as e: print("Exception when calling ComputationApi->retrieve_result: %s\n" % e) @@ -1474,10 +1474,10 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| Workspace identifier | **result_id** | **str**| Result ID | + **x_gdc_cancel_token** | **str**| | [optional] **offset** | **[int]**| Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM. | [optional] if omitted the server will use the default value of [] **limit** | **[int]**| Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM. | [optional] if omitted the server will use the default value of [] **excluded_total_dimensions** | **[str]**| Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions. | [optional] if omitted the server will use the default value of [] - **x_gdc_cancel_token** | **str**| | [optional] ### Return type @@ -1490,7 +1490,7 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json + - **Accept**: application/json, application/vnd.apache.arrow.file, application/vnd.apache.arrow.stream ### HTTP response details diff --git a/gooddata-api-client/docs/CookieSecurityConfigurationControllerApi.md b/gooddata-api-client/docs/CookieSecurityConfigurationControllerApi.md new file mode 100644 index 000000000..82d99ead9 --- /dev/null +++ b/gooddata-api-client/docs/CookieSecurityConfigurationControllerApi.md @@ -0,0 +1,263 @@ +# gooddata_api_client.CookieSecurityConfigurationControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_entity_cookie_security_configurations**](CookieSecurityConfigurationControllerApi.md#get_entity_cookie_security_configurations) | **GET** /api/v1/entities/admin/cookieSecurityConfigurations/{id} | Get CookieSecurityConfiguration +[**patch_entity_cookie_security_configurations**](CookieSecurityConfigurationControllerApi.md#patch_entity_cookie_security_configurations) | **PATCH** /api/v1/entities/admin/cookieSecurityConfigurations/{id} | Patch CookieSecurityConfiguration +[**update_entity_cookie_security_configurations**](CookieSecurityConfigurationControllerApi.md#update_entity_cookie_security_configurations) | **PUT** /api/v1/entities/admin/cookieSecurityConfigurations/{id} | Put CookieSecurityConfiguration + + +# **get_entity_cookie_security_configurations** +> JsonApiCookieSecurityConfigurationOutDocument get_entity_cookie_security_configurations(id) + +Get CookieSecurityConfiguration + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import cookie_security_configuration_controller_api +from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = cookie_security_configuration_controller_api.CookieSecurityConfigurationControllerApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + filter = "lastRotation==InstantValue;rotationInterval==DurationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Get CookieSecurityConfiguration + api_response = api_instance.get_entity_cookie_security_configurations(id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling CookieSecurityConfigurationControllerApi->get_entity_cookie_security_configurations: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get CookieSecurityConfiguration + api_response = api_instance.get_entity_cookie_security_configurations(id, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling CookieSecurityConfigurationControllerApi->get_entity_cookie_security_configurations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiCookieSecurityConfigurationOutDocument**](JsonApiCookieSecurityConfigurationOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **patch_entity_cookie_security_configurations** +> JsonApiCookieSecurityConfigurationOutDocument patch_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_patch_document) + +Patch CookieSecurityConfiguration + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import cookie_security_configuration_controller_api +from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.model.json_api_cookie_security_configuration_patch_document import JsonApiCookieSecurityConfigurationPatchDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = cookie_security_configuration_controller_api.CookieSecurityConfigurationControllerApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + json_api_cookie_security_configuration_patch_document = JsonApiCookieSecurityConfigurationPatchDocument( + data=JsonApiCookieSecurityConfigurationPatch( + attributes=JsonApiCookieSecurityConfigurationInAttributes( + last_rotation=dateutil_parser('1970-01-01T00:00:00.00Z'), + rotation_interval="P30D", + ), + id="id1", + type="cookieSecurityConfiguration", + ), + ) # JsonApiCookieSecurityConfigurationPatchDocument | + filter = "lastRotation==InstantValue;rotationInterval==DurationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Patch CookieSecurityConfiguration + api_response = api_instance.patch_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling CookieSecurityConfigurationControllerApi->patch_entity_cookie_security_configurations: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch CookieSecurityConfiguration + api_response = api_instance.patch_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_patch_document, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling CookieSecurityConfigurationControllerApi->patch_entity_cookie_security_configurations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **json_api_cookie_security_configuration_patch_document** | [**JsonApiCookieSecurityConfigurationPatchDocument**](JsonApiCookieSecurityConfigurationPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiCookieSecurityConfigurationOutDocument**](JsonApiCookieSecurityConfigurationOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_entity_cookie_security_configurations** +> JsonApiCookieSecurityConfigurationOutDocument update_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_in_document) + +Put CookieSecurityConfiguration + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import cookie_security_configuration_controller_api +from gooddata_api_client.model.json_api_cookie_security_configuration_in_document import JsonApiCookieSecurityConfigurationInDocument +from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = cookie_security_configuration_controller_api.CookieSecurityConfigurationControllerApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + json_api_cookie_security_configuration_in_document = JsonApiCookieSecurityConfigurationInDocument( + data=JsonApiCookieSecurityConfigurationIn( + attributes=JsonApiCookieSecurityConfigurationInAttributes( + last_rotation=dateutil_parser('1970-01-01T00:00:00.00Z'), + rotation_interval="P30D", + ), + id="id1", + type="cookieSecurityConfiguration", + ), + ) # JsonApiCookieSecurityConfigurationInDocument | + filter = "lastRotation==InstantValue;rotationInterval==DurationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Put CookieSecurityConfiguration + api_response = api_instance.update_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling CookieSecurityConfigurationControllerApi->update_entity_cookie_security_configurations: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put CookieSecurityConfiguration + api_response = api_instance.update_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_in_document, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling CookieSecurityConfigurationControllerApi->update_entity_cookie_security_configurations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **json_api_cookie_security_configuration_in_document** | [**JsonApiCookieSecurityConfigurationInDocument**](JsonApiCookieSecurityConfigurationInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiCookieSecurityConfigurationOutDocument**](JsonApiCookieSecurityConfigurationOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/gooddata-api-client/docs/CustomApplicationSettingControllerApi.md b/gooddata-api-client/docs/CustomApplicationSettingControllerApi.md new file mode 100644 index 000000000..b31cc8818 --- /dev/null +++ b/gooddata-api-client/docs/CustomApplicationSettingControllerApi.md @@ -0,0 +1,635 @@ +# gooddata_api_client.CustomApplicationSettingControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_custom_application_settings**](CustomApplicationSettingControllerApi.md#create_entity_custom_application_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings | Post Custom Application Settings +[**delete_entity_custom_application_settings**](CustomApplicationSettingControllerApi.md#delete_entity_custom_application_settings) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Delete a Custom Application Setting +[**get_all_entities_custom_application_settings**](CustomApplicationSettingControllerApi.md#get_all_entities_custom_application_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings | Get all Custom Application Settings +[**get_entity_custom_application_settings**](CustomApplicationSettingControllerApi.md#get_entity_custom_application_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Get a Custom Application Setting +[**patch_entity_custom_application_settings**](CustomApplicationSettingControllerApi.md#patch_entity_custom_application_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Patch a Custom Application Setting +[**search_entities_custom_application_settings**](CustomApplicationSettingControllerApi.md#search_entities_custom_application_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search | The search endpoint (beta) +[**update_entity_custom_application_settings**](CustomApplicationSettingControllerApi.md#update_entity_custom_application_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Put a Custom Application Setting + + +# **create_entity_custom_application_settings** +> JsonApiCustomApplicationSettingOutDocument create_entity_custom_application_settings(workspace_id, json_api_custom_application_setting_post_optional_id_document) + +Post Custom Application Settings + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import custom_application_setting_controller_api +from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.model.json_api_custom_application_setting_post_optional_id_document import JsonApiCustomApplicationSettingPostOptionalIdDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = custom_application_setting_controller_api.CustomApplicationSettingControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + json_api_custom_application_setting_post_optional_id_document = JsonApiCustomApplicationSettingPostOptionalIdDocument( + data=JsonApiCustomApplicationSettingPostOptionalId( + attributes=JsonApiCustomApplicationSettingInAttributes( + application_name="application_name_example", + content={}, + ), + id="id1", + type="customApplicationSetting", + ), + ) # JsonApiCustomApplicationSettingPostOptionalIdDocument | + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Custom Application Settings + api_response = api_instance.create_entity_custom_application_settings(workspace_id, json_api_custom_application_setting_post_optional_id_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling CustomApplicationSettingControllerApi->create_entity_custom_application_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Custom Application Settings + api_response = api_instance.create_entity_custom_application_settings(workspace_id, json_api_custom_application_setting_post_optional_id_document, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling CustomApplicationSettingControllerApi->create_entity_custom_application_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_custom_application_setting_post_optional_id_document** | [**JsonApiCustomApplicationSettingPostOptionalIdDocument**](JsonApiCustomApplicationSettingPostOptionalIdDocument.md)| | + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiCustomApplicationSettingOutDocument**](JsonApiCustomApplicationSettingOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_entity_custom_application_settings** +> delete_entity_custom_application_settings(workspace_id, object_id) + +Delete a Custom Application Setting + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import custom_application_setting_controller_api +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = custom_application_setting_controller_api.CustomApplicationSettingControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "applicationName==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Delete a Custom Application Setting + api_instance.delete_entity_custom_application_settings(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling CustomApplicationSettingControllerApi->delete_entity_custom_application_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete a Custom Application Setting + api_instance.delete_entity_custom_application_settings(workspace_id, object_id, filter=filter) + except gooddata_api_client.ApiException as e: + print("Exception when calling CustomApplicationSettingControllerApi->delete_entity_custom_application_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successfully deleted | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_entities_custom_application_settings** +> JsonApiCustomApplicationSettingOutList get_all_entities_custom_application_settings(workspace_id) + +Get all Custom Application Settings + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import custom_application_setting_controller_api +from gooddata_api_client.model.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = custom_application_setting_controller_api.CustomApplicationSettingControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "applicationName==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get all Custom Application Settings + api_response = api_instance.get_all_entities_custom_application_settings(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling CustomApplicationSettingControllerApi->get_all_entities_custom_application_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Custom Application Settings + api_response = api_instance.get_all_entities_custom_application_settings(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling CustomApplicationSettingControllerApi->get_all_entities_custom_application_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiCustomApplicationSettingOutList**](JsonApiCustomApplicationSettingOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_custom_application_settings** +> JsonApiCustomApplicationSettingOutDocument get_entity_custom_application_settings(workspace_id, object_id) + +Get a Custom Application Setting + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import custom_application_setting_controller_api +from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = custom_application_setting_controller_api.CustomApplicationSettingControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "applicationName==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a Custom Application Setting + api_response = api_instance.get_entity_custom_application_settings(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling CustomApplicationSettingControllerApi->get_entity_custom_application_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Custom Application Setting + api_response = api_instance.get_entity_custom_application_settings(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling CustomApplicationSettingControllerApi->get_entity_custom_application_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiCustomApplicationSettingOutDocument**](JsonApiCustomApplicationSettingOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **patch_entity_custom_application_settings** +> JsonApiCustomApplicationSettingOutDocument patch_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_patch_document) + +Patch a Custom Application Setting + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import custom_application_setting_controller_api +from gooddata_api_client.model.json_api_custom_application_setting_patch_document import JsonApiCustomApplicationSettingPatchDocument +from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = custom_application_setting_controller_api.CustomApplicationSettingControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_custom_application_setting_patch_document = JsonApiCustomApplicationSettingPatchDocument( + data=JsonApiCustomApplicationSettingPatch( + attributes=JsonApiCustomApplicationSettingPatchAttributes( + application_name="application_name_example", + content={}, + ), + id="id1", + type="customApplicationSetting", + ), + ) # JsonApiCustomApplicationSettingPatchDocument | + filter = "applicationName==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Patch a Custom Application Setting + api_response = api_instance.patch_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling CustomApplicationSettingControllerApi->patch_entity_custom_application_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch a Custom Application Setting + api_response = api_instance.patch_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_patch_document, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling CustomApplicationSettingControllerApi->patch_entity_custom_application_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_custom_application_setting_patch_document** | [**JsonApiCustomApplicationSettingPatchDocument**](JsonApiCustomApplicationSettingPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiCustomApplicationSettingOutDocument**](JsonApiCustomApplicationSettingOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **search_entities_custom_application_settings** +> JsonApiCustomApplicationSettingOutList search_entities_custom_application_settings(workspace_id, entity_search_body) + +The search endpoint (beta) + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import custom_application_setting_controller_api +from gooddata_api_client.model.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = custom_application_setting_controller_api.CustomApplicationSettingControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + entity_search_body = EntitySearchBody( + filter="filter_example", + include=[ + "include_example", + ], + meta_include=[ + "meta_include_example", + ], + page=EntitySearchPage( + index=0, + size=100, + ), + sort=[ + EntitySearchSort( + direction="ASC", + _property="_property_example", + ), + ], + ) # EntitySearchBody | Search request body with filter, pagination, and sorting options + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_custom_application_settings(workspace_id, entity_search_body) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling CustomApplicationSettingControllerApi->search_entities_custom_application_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_custom_application_settings(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling CustomApplicationSettingControllerApi->search_entities_custom_application_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + +### Return type + +[**JsonApiCustomApplicationSettingOutList**](JsonApiCustomApplicationSettingOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_entity_custom_application_settings** +> JsonApiCustomApplicationSettingOutDocument update_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_in_document) + +Put a Custom Application Setting + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import custom_application_setting_controller_api +from gooddata_api_client.model.json_api_custom_application_setting_in_document import JsonApiCustomApplicationSettingInDocument +from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = custom_application_setting_controller_api.CustomApplicationSettingControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_custom_application_setting_in_document = JsonApiCustomApplicationSettingInDocument( + data=JsonApiCustomApplicationSettingIn( + attributes=JsonApiCustomApplicationSettingInAttributes( + application_name="application_name_example", + content={}, + ), + id="id1", + type="customApplicationSetting", + ), + ) # JsonApiCustomApplicationSettingInDocument | + filter = "applicationName==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Put a Custom Application Setting + api_response = api_instance.update_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling CustomApplicationSettingControllerApi->update_entity_custom_application_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put a Custom Application Setting + api_response = api_instance.update_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_in_document, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling CustomApplicationSettingControllerApi->update_entity_custom_application_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_custom_application_setting_in_document** | [**JsonApiCustomApplicationSettingInDocument**](JsonApiCustomApplicationSettingInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiCustomApplicationSettingOutDocument**](JsonApiCustomApplicationSettingOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/gooddata-api-client/docs/CustomGeoCollectionControllerApi.md b/gooddata-api-client/docs/CustomGeoCollectionControllerApi.md new file mode 100644 index 000000000..acbf75afe --- /dev/null +++ b/gooddata-api-client/docs/CustomGeoCollectionControllerApi.md @@ -0,0 +1,492 @@ +# gooddata_api_client.CustomGeoCollectionControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_custom_geo_collections**](CustomGeoCollectionControllerApi.md#create_entity_custom_geo_collections) | **POST** /api/v1/entities/customGeoCollections | Post Custom Geo Collections +[**delete_entity_custom_geo_collections**](CustomGeoCollectionControllerApi.md#delete_entity_custom_geo_collections) | **DELETE** /api/v1/entities/customGeoCollections/{id} | Delete Custom Geo Collection +[**get_all_entities_custom_geo_collections**](CustomGeoCollectionControllerApi.md#get_all_entities_custom_geo_collections) | **GET** /api/v1/entities/customGeoCollections | Get all Custom Geo Collections +[**get_entity_custom_geo_collections**](CustomGeoCollectionControllerApi.md#get_entity_custom_geo_collections) | **GET** /api/v1/entities/customGeoCollections/{id} | Get Custom Geo Collection +[**patch_entity_custom_geo_collections**](CustomGeoCollectionControllerApi.md#patch_entity_custom_geo_collections) | **PATCH** /api/v1/entities/customGeoCollections/{id} | Patch Custom Geo Collection +[**update_entity_custom_geo_collections**](CustomGeoCollectionControllerApi.md#update_entity_custom_geo_collections) | **PUT** /api/v1/entities/customGeoCollections/{id} | Put Custom Geo Collection + + +# **create_entity_custom_geo_collections** +> JsonApiCustomGeoCollectionOutDocument create_entity_custom_geo_collections(json_api_custom_geo_collection_in_document) + +Post Custom Geo Collections + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import custom_geo_collection_controller_api +from gooddata_api_client.model.json_api_custom_geo_collection_out_document import JsonApiCustomGeoCollectionOutDocument +from gooddata_api_client.model.json_api_custom_geo_collection_in_document import JsonApiCustomGeoCollectionInDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = custom_geo_collection_controller_api.CustomGeoCollectionControllerApi(api_client) + json_api_custom_geo_collection_in_document = JsonApiCustomGeoCollectionInDocument( + data=JsonApiCustomGeoCollectionIn( + attributes=JsonApiCustomGeoCollectionInAttributes( + description="description_example", + name="name_example", + ), + id="id1", + type="customGeoCollection", + ), + ) # JsonApiCustomGeoCollectionInDocument | + + # example passing only required values which don't have defaults set + try: + # Post Custom Geo Collections + api_response = api_instance.create_entity_custom_geo_collections(json_api_custom_geo_collection_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling CustomGeoCollectionControllerApi->create_entity_custom_geo_collections: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **json_api_custom_geo_collection_in_document** | [**JsonApiCustomGeoCollectionInDocument**](JsonApiCustomGeoCollectionInDocument.md)| | + +### Return type + +[**JsonApiCustomGeoCollectionOutDocument**](JsonApiCustomGeoCollectionOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_entity_custom_geo_collections** +> delete_entity_custom_geo_collections(id) + +Delete Custom Geo Collection + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import custom_geo_collection_controller_api +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = custom_geo_collection_controller_api.CustomGeoCollectionControllerApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Delete Custom Geo Collection + api_instance.delete_entity_custom_geo_collections(id) + except gooddata_api_client.ApiException as e: + print("Exception when calling CustomGeoCollectionControllerApi->delete_entity_custom_geo_collections: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete Custom Geo Collection + api_instance.delete_entity_custom_geo_collections(id, filter=filter) + except gooddata_api_client.ApiException as e: + print("Exception when calling CustomGeoCollectionControllerApi->delete_entity_custom_geo_collections: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successfully deleted | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_entities_custom_geo_collections** +> JsonApiCustomGeoCollectionOutList get_all_entities_custom_geo_collections() + +Get all Custom Geo Collections + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import custom_geo_collection_controller_api +from gooddata_api_client.model.json_api_custom_geo_collection_out_list import JsonApiCustomGeoCollectionOutList +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = custom_geo_collection_controller_api.CustomGeoCollectionControllerApi(api_client) + filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = [ + "metaInclude=page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Custom Geo Collections + api_response = api_instance.get_all_entities_custom_geo_collections(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling CustomGeoCollectionControllerApi->get_all_entities_custom_geo_collections: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiCustomGeoCollectionOutList**](JsonApiCustomGeoCollectionOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_custom_geo_collections** +> JsonApiCustomGeoCollectionOutDocument get_entity_custom_geo_collections(id) + +Get Custom Geo Collection + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import custom_geo_collection_controller_api +from gooddata_api_client.model.json_api_custom_geo_collection_out_document import JsonApiCustomGeoCollectionOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = custom_geo_collection_controller_api.CustomGeoCollectionControllerApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Get Custom Geo Collection + api_response = api_instance.get_entity_custom_geo_collections(id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling CustomGeoCollectionControllerApi->get_entity_custom_geo_collections: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Custom Geo Collection + api_response = api_instance.get_entity_custom_geo_collections(id, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling CustomGeoCollectionControllerApi->get_entity_custom_geo_collections: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiCustomGeoCollectionOutDocument**](JsonApiCustomGeoCollectionOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **patch_entity_custom_geo_collections** +> JsonApiCustomGeoCollectionOutDocument patch_entity_custom_geo_collections(id, json_api_custom_geo_collection_patch_document) + +Patch Custom Geo Collection + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import custom_geo_collection_controller_api +from gooddata_api_client.model.json_api_custom_geo_collection_patch_document import JsonApiCustomGeoCollectionPatchDocument +from gooddata_api_client.model.json_api_custom_geo_collection_out_document import JsonApiCustomGeoCollectionOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = custom_geo_collection_controller_api.CustomGeoCollectionControllerApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + json_api_custom_geo_collection_patch_document = JsonApiCustomGeoCollectionPatchDocument( + data=JsonApiCustomGeoCollectionPatch( + attributes=JsonApiCustomGeoCollectionInAttributes( + description="description_example", + name="name_example", + ), + id="id1", + type="customGeoCollection", + ), + ) # JsonApiCustomGeoCollectionPatchDocument | + filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Patch Custom Geo Collection + api_response = api_instance.patch_entity_custom_geo_collections(id, json_api_custom_geo_collection_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling CustomGeoCollectionControllerApi->patch_entity_custom_geo_collections: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch Custom Geo Collection + api_response = api_instance.patch_entity_custom_geo_collections(id, json_api_custom_geo_collection_patch_document, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling CustomGeoCollectionControllerApi->patch_entity_custom_geo_collections: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **json_api_custom_geo_collection_patch_document** | [**JsonApiCustomGeoCollectionPatchDocument**](JsonApiCustomGeoCollectionPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiCustomGeoCollectionOutDocument**](JsonApiCustomGeoCollectionOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_entity_custom_geo_collections** +> JsonApiCustomGeoCollectionOutDocument update_entity_custom_geo_collections(id, json_api_custom_geo_collection_in_document) + +Put Custom Geo Collection + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import custom_geo_collection_controller_api +from gooddata_api_client.model.json_api_custom_geo_collection_out_document import JsonApiCustomGeoCollectionOutDocument +from gooddata_api_client.model.json_api_custom_geo_collection_in_document import JsonApiCustomGeoCollectionInDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = custom_geo_collection_controller_api.CustomGeoCollectionControllerApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + json_api_custom_geo_collection_in_document = JsonApiCustomGeoCollectionInDocument( + data=JsonApiCustomGeoCollectionIn( + attributes=JsonApiCustomGeoCollectionInAttributes( + description="description_example", + name="name_example", + ), + id="id1", + type="customGeoCollection", + ), + ) # JsonApiCustomGeoCollectionInDocument | + filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Put Custom Geo Collection + api_response = api_instance.update_entity_custom_geo_collections(id, json_api_custom_geo_collection_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling CustomGeoCollectionControllerApi->update_entity_custom_geo_collections: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put Custom Geo Collection + api_response = api_instance.update_entity_custom_geo_collections(id, json_api_custom_geo_collection_in_document, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling CustomGeoCollectionControllerApi->update_entity_custom_geo_collections: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **json_api_custom_geo_collection_in_document** | [**JsonApiCustomGeoCollectionInDocument**](JsonApiCustomGeoCollectionInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiCustomGeoCollectionOutDocument**](JsonApiCustomGeoCollectionOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/gooddata-api-client/docs/DashboardContext.md b/gooddata-api-client/docs/DashboardContext.md new file mode 100644 index 000000000..b8b951a8e --- /dev/null +++ b/gooddata-api-client/docs/DashboardContext.md @@ -0,0 +1,14 @@ +# DashboardContext + +Dashboard the user is currently viewing. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Dashboard object ID. | +**widgets** | [**[DashboardContextWidgetsInner]**](DashboardContextWidgetsInner.md) | Widgets currently visible on the dashboard. | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/DashboardContextWidgetsInner.md b/gooddata-api-client/docs/DashboardContextWidgetsInner.md new file mode 100644 index 000000000..32e962433 --- /dev/null +++ b/gooddata-api-client/docs/DashboardContextWidgetsInner.md @@ -0,0 +1,18 @@ +# DashboardContextWidgetsInner + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**widget_type** | **str** | | +**result_id** | **str** | Signed result ID for the currently active visualization's execution result. | [optional] +**title** | **str** | Widget title as displayed on the dashboard. | [optional] +**widget_id** | **str** | Widget object ID. | [optional] +**active_visualization_id** | **str** | ID of the currently active visualization in the switcher. | [optional] +**visualization_ids** | **[str]** | IDs of all visualizations available in the switcher. | [optional] +**visualization_id** | **str** | Visualization object ID referenced by this insight widget. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/DashboardPluginControllerApi.md b/gooddata-api-client/docs/DashboardPluginControllerApi.md new file mode 100644 index 000000000..02a369ed3 --- /dev/null +++ b/gooddata-api-client/docs/DashboardPluginControllerApi.md @@ -0,0 +1,670 @@ +# gooddata_api_client.DashboardPluginControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_dashboard_plugins**](DashboardPluginControllerApi.md#create_entity_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins | Post Plugins +[**delete_entity_dashboard_plugins**](DashboardPluginControllerApi.md#delete_entity_dashboard_plugins) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Delete a Plugin +[**get_all_entities_dashboard_plugins**](DashboardPluginControllerApi.md#get_all_entities_dashboard_plugins) | **GET** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins | Get all Plugins +[**get_entity_dashboard_plugins**](DashboardPluginControllerApi.md#get_entity_dashboard_plugins) | **GET** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Get a Plugin +[**patch_entity_dashboard_plugins**](DashboardPluginControllerApi.md#patch_entity_dashboard_plugins) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Patch a Plugin +[**search_entities_dashboard_plugins**](DashboardPluginControllerApi.md#search_entities_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search | The search endpoint (beta) +[**update_entity_dashboard_plugins**](DashboardPluginControllerApi.md#update_entity_dashboard_plugins) | **PUT** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Put a Plugin + + +# **create_entity_dashboard_plugins** +> JsonApiDashboardPluginOutDocument create_entity_dashboard_plugins(workspace_id, json_api_dashboard_plugin_post_optional_id_document) + +Post Plugins + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import dashboard_plugin_controller_api +from gooddata_api_client.model.json_api_dashboard_plugin_post_optional_id_document import JsonApiDashboardPluginPostOptionalIdDocument +from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = dashboard_plugin_controller_api.DashboardPluginControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + json_api_dashboard_plugin_post_optional_id_document = JsonApiDashboardPluginPostOptionalIdDocument( + data=JsonApiDashboardPluginPostOptionalId( + attributes=JsonApiDashboardPluginInAttributes( + are_relations_valid=True, + content={}, + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="dashboardPlugin", + ), + ) # JsonApiDashboardPluginPostOptionalIdDocument | + include = [ + "createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Plugins + api_response = api_instance.create_entity_dashboard_plugins(workspace_id, json_api_dashboard_plugin_post_optional_id_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DashboardPluginControllerApi->create_entity_dashboard_plugins: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Plugins + api_response = api_instance.create_entity_dashboard_plugins(workspace_id, json_api_dashboard_plugin_post_optional_id_document, include=include, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DashboardPluginControllerApi->create_entity_dashboard_plugins: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_dashboard_plugin_post_optional_id_document** | [**JsonApiDashboardPluginPostOptionalIdDocument**](JsonApiDashboardPluginPostOptionalIdDocument.md)| | + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiDashboardPluginOutDocument**](JsonApiDashboardPluginOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_entity_dashboard_plugins** +> delete_entity_dashboard_plugins(workspace_id, object_id) + +Delete a Plugin + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import dashboard_plugin_controller_api +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = dashboard_plugin_controller_api.DashboardPluginControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Delete a Plugin + api_instance.delete_entity_dashboard_plugins(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling DashboardPluginControllerApi->delete_entity_dashboard_plugins: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete a Plugin + api_instance.delete_entity_dashboard_plugins(workspace_id, object_id, filter=filter) + except gooddata_api_client.ApiException as e: + print("Exception when calling DashboardPluginControllerApi->delete_entity_dashboard_plugins: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successfully deleted | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_entities_dashboard_plugins** +> JsonApiDashboardPluginOutList get_all_entities_dashboard_plugins(workspace_id) + +Get all Plugins + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import dashboard_plugin_controller_api +from gooddata_api_client.model.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = dashboard_plugin_controller_api.DashboardPluginControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get all Plugins + api_response = api_instance.get_all_entities_dashboard_plugins(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DashboardPluginControllerApi->get_all_entities_dashboard_plugins: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Plugins + api_response = api_instance.get_all_entities_dashboard_plugins(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DashboardPluginControllerApi->get_all_entities_dashboard_plugins: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiDashboardPluginOutList**](JsonApiDashboardPluginOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_dashboard_plugins** +> JsonApiDashboardPluginOutDocument get_entity_dashboard_plugins(workspace_id, object_id) + +Get a Plugin + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import dashboard_plugin_controller_api +from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = dashboard_plugin_controller_api.DashboardPluginControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a Plugin + api_response = api_instance.get_entity_dashboard_plugins(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DashboardPluginControllerApi->get_entity_dashboard_plugins: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Plugin + api_response = api_instance.get_entity_dashboard_plugins(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DashboardPluginControllerApi->get_entity_dashboard_plugins: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiDashboardPluginOutDocument**](JsonApiDashboardPluginOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **patch_entity_dashboard_plugins** +> JsonApiDashboardPluginOutDocument patch_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_patch_document) + +Patch a Plugin + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import dashboard_plugin_controller_api +from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.model.json_api_dashboard_plugin_patch_document import JsonApiDashboardPluginPatchDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = dashboard_plugin_controller_api.DashboardPluginControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_dashboard_plugin_patch_document = JsonApiDashboardPluginPatchDocument( + data=JsonApiDashboardPluginPatch( + attributes=JsonApiDashboardPluginInAttributes( + are_relations_valid=True, + content={}, + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="dashboardPlugin", + ), + ) # JsonApiDashboardPluginPatchDocument | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Patch a Plugin + api_response = api_instance.patch_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DashboardPluginControllerApi->patch_entity_dashboard_plugins: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch a Plugin + api_response = api_instance.patch_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DashboardPluginControllerApi->patch_entity_dashboard_plugins: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_dashboard_plugin_patch_document** | [**JsonApiDashboardPluginPatchDocument**](JsonApiDashboardPluginPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiDashboardPluginOutDocument**](JsonApiDashboardPluginOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **search_entities_dashboard_plugins** +> JsonApiDashboardPluginOutList search_entities_dashboard_plugins(workspace_id, entity_search_body) + +The search endpoint (beta) + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import dashboard_plugin_controller_api +from gooddata_api_client.model.entity_search_body import EntitySearchBody +from gooddata_api_client.model.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = dashboard_plugin_controller_api.DashboardPluginControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + entity_search_body = EntitySearchBody( + filter="filter_example", + include=[ + "include_example", + ], + meta_include=[ + "meta_include_example", + ], + page=EntitySearchPage( + index=0, + size=100, + ), + sort=[ + EntitySearchSort( + direction="ASC", + _property="_property_example", + ), + ], + ) # EntitySearchBody | Search request body with filter, pagination, and sorting options + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_dashboard_plugins(workspace_id, entity_search_body) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DashboardPluginControllerApi->search_entities_dashboard_plugins: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_dashboard_plugins(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DashboardPluginControllerApi->search_entities_dashboard_plugins: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + +### Return type + +[**JsonApiDashboardPluginOutList**](JsonApiDashboardPluginOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_entity_dashboard_plugins** +> JsonApiDashboardPluginOutDocument update_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_in_document) + +Put a Plugin + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import dashboard_plugin_controller_api +from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.model.json_api_dashboard_plugin_in_document import JsonApiDashboardPluginInDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = dashboard_plugin_controller_api.DashboardPluginControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_dashboard_plugin_in_document = JsonApiDashboardPluginInDocument( + data=JsonApiDashboardPluginIn( + attributes=JsonApiDashboardPluginInAttributes( + are_relations_valid=True, + content={}, + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="dashboardPlugin", + ), + ) # JsonApiDashboardPluginInDocument | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Put a Plugin + api_response = api_instance.update_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DashboardPluginControllerApi->update_entity_dashboard_plugins: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put a Plugin + api_response = api_instance.update_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DashboardPluginControllerApi->update_entity_dashboard_plugins: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_dashboard_plugin_in_document** | [**JsonApiDashboardPluginInDocument**](JsonApiDashboardPluginInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiDashboardPluginOutDocument**](JsonApiDashboardPluginOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/gooddata-api-client/docs/DashboardsApi.md b/gooddata-api-client/docs/DashboardsApi.md index 1f01d5637..55f29993e 100644 --- a/gooddata-api-client/docs/DashboardsApi.md +++ b/gooddata-api-client/docs/DashboardsApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description [**get_all_entities_analytical_dashboards**](DashboardsApi.md#get_all_entities_analytical_dashboards) | **GET** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards | Get all Dashboards [**get_entity_analytical_dashboards**](DashboardsApi.md#get_entity_analytical_dashboards) | **GET** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Get a Dashboard [**patch_entity_analytical_dashboards**](DashboardsApi.md#patch_entity_analytical_dashboards) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Patch a Dashboard -[**search_entities_analytical_dashboards**](DashboardsApi.md#search_entities_analytical_dashboards) | **POST** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search | Search request for AnalyticalDashboard +[**search_entities_analytical_dashboards**](DashboardsApi.md#search_entities_analytical_dashboards) | **POST** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search | The search endpoint (beta) [**update_entity_analytical_dashboards**](DashboardsApi.md#update_entity_analytical_dashboards) | **PUT** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Put Dashboards @@ -475,7 +475,7 @@ No authorization required # **search_entities_analytical_dashboards** > JsonApiAnalyticalDashboardOutList search_entities_analytical_dashboards(workspace_id, entity_search_body) -Search request for AnalyticalDashboard +The search endpoint (beta) ### Example @@ -523,7 +523,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Search request for AnalyticalDashboard + # The search endpoint (beta) api_response = api_instance.search_entities_analytical_dashboards(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -532,7 +532,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Search request for AnalyticalDashboard + # The search endpoint (beta) api_response = api_instance.search_entities_analytical_dashboards(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/DataFiltersApi.md b/gooddata-api-client/docs/DataFiltersApi.md index 4b4199e79..c2a1a296b 100644 --- a/gooddata-api-client/docs/DataFiltersApi.md +++ b/gooddata-api-client/docs/DataFiltersApi.md @@ -20,9 +20,9 @@ Method | HTTP request | Description [**patch_entity_user_data_filters**](DataFiltersApi.md#patch_entity_user_data_filters) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Patch a User Data Filter [**patch_entity_workspace_data_filter_settings**](DataFiltersApi.md#patch_entity_workspace_data_filter_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Patch a Settings for Workspace Data Filter [**patch_entity_workspace_data_filters**](DataFiltersApi.md#patch_entity_workspace_data_filters) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Patch a Workspace Data Filter -[**search_entities_user_data_filters**](DataFiltersApi.md#search_entities_user_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/search | Search request for UserDataFilter -[**search_entities_workspace_data_filter_settings**](DataFiltersApi.md#search_entities_workspace_data_filter_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/search | Search request for WorkspaceDataFilterSetting -[**search_entities_workspace_data_filters**](DataFiltersApi.md#search_entities_workspace_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/search | Search request for WorkspaceDataFilter +[**search_entities_user_data_filters**](DataFiltersApi.md#search_entities_user_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/search | The search endpoint (beta) +[**search_entities_workspace_data_filter_settings**](DataFiltersApi.md#search_entities_workspace_data_filter_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/search | The search endpoint (beta) +[**search_entities_workspace_data_filters**](DataFiltersApi.md#search_entities_workspace_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/search | The search endpoint (beta) [**set_workspace_data_filters_layout**](DataFiltersApi.md#set_workspace_data_filters_layout) | **PUT** /api/v1/layout/workspaceDataFilters | Set all workspace data filters [**update_entity_user_data_filters**](DataFiltersApi.md#update_entity_user_data_filters) | **PUT** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Put a User Data Filter [**update_entity_workspace_data_filter_settings**](DataFiltersApi.md#update_entity_workspace_data_filter_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Put a Settings for Workspace Data Filter @@ -1500,7 +1500,7 @@ No authorization required # **search_entities_user_data_filters** > JsonApiUserDataFilterOutList search_entities_user_data_filters(workspace_id, entity_search_body) -Search request for UserDataFilter +The search endpoint (beta) ### Example @@ -1548,7 +1548,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Search request for UserDataFilter + # The search endpoint (beta) api_response = api_instance.search_entities_user_data_filters(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -1557,7 +1557,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Search request for UserDataFilter + # The search endpoint (beta) api_response = api_instance.search_entities_user_data_filters(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -1599,7 +1599,7 @@ No authorization required # **search_entities_workspace_data_filter_settings** > JsonApiWorkspaceDataFilterSettingOutList search_entities_workspace_data_filter_settings(workspace_id, entity_search_body) -Search request for WorkspaceDataFilterSetting +The search endpoint (beta) ### Example @@ -1647,7 +1647,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Search request for WorkspaceDataFilterSetting + # The search endpoint (beta) api_response = api_instance.search_entities_workspace_data_filter_settings(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -1656,7 +1656,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Search request for WorkspaceDataFilterSetting + # The search endpoint (beta) api_response = api_instance.search_entities_workspace_data_filter_settings(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -1698,7 +1698,7 @@ No authorization required # **search_entities_workspace_data_filters** > JsonApiWorkspaceDataFilterOutList search_entities_workspace_data_filters(workspace_id, entity_search_body) -Search request for WorkspaceDataFilter +The search endpoint (beta) ### Example @@ -1746,7 +1746,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Search request for WorkspaceDataFilter + # The search endpoint (beta) api_response = api_instance.search_entities_workspace_data_filters(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -1755,7 +1755,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Search request for WorkspaceDataFilter + # The search endpoint (beta) api_response = api_instance.search_entities_workspace_data_filters(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/DataSourceControllerApi.md b/gooddata-api-client/docs/DataSourceControllerApi.md new file mode 100644 index 000000000..9e83fffb6 --- /dev/null +++ b/gooddata-api-client/docs/DataSourceControllerApi.md @@ -0,0 +1,572 @@ +# gooddata_api_client.DataSourceControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_data_sources**](DataSourceControllerApi.md#create_entity_data_sources) | **POST** /api/v1/entities/dataSources | Post Data Sources +[**delete_entity_data_sources**](DataSourceControllerApi.md#delete_entity_data_sources) | **DELETE** /api/v1/entities/dataSources/{id} | Delete Data Source entity +[**get_all_entities_data_sources**](DataSourceControllerApi.md#get_all_entities_data_sources) | **GET** /api/v1/entities/dataSources | Get Data Source entities +[**get_entity_data_sources**](DataSourceControllerApi.md#get_entity_data_sources) | **GET** /api/v1/entities/dataSources/{id} | Get Data Source entity +[**patch_entity_data_sources**](DataSourceControllerApi.md#patch_entity_data_sources) | **PATCH** /api/v1/entities/dataSources/{id} | Patch Data Source entity +[**update_entity_data_sources**](DataSourceControllerApi.md#update_entity_data_sources) | **PUT** /api/v1/entities/dataSources/{id} | Put Data Source entity + + +# **create_entity_data_sources** +> JsonApiDataSourceOutDocument create_entity_data_sources(json_api_data_source_in_document) + +Post Data Sources + +Data Source - represents data source for the workspace + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import data_source_controller_api +from gooddata_api_client.model.json_api_data_source_in_document import JsonApiDataSourceInDocument +from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = data_source_controller_api.DataSourceControllerApi(api_client) + json_api_data_source_in_document = JsonApiDataSourceInDocument( + data=JsonApiDataSourceIn( + attributes=JsonApiDataSourceInAttributes( + alternative_data_source_id="pg_local_docker-demo2", + cache_strategy="ALWAYS", + client_id="client_id_example", + client_secret="client_secret_example", + name="name_example", + parameters=[ + JsonApiDataSourceInAttributesParametersInner( + name="name_example", + value="value_example", + ), + ], + password="password_example", + private_key="private_key_example", + private_key_passphrase="private_key_passphrase_example", + schema="schema_example", + token="token_example", + type="POSTGRESQL", + url="url_example", + username="username_example", + ), + id="id1", + type="dataSource", + ), + ) # JsonApiDataSourceInDocument | + meta_include = [ + "metaInclude=permissions,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Data Sources + api_response = api_instance.create_entity_data_sources(json_api_data_source_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DataSourceControllerApi->create_entity_data_sources: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Data Sources + api_response = api_instance.create_entity_data_sources(json_api_data_source_in_document, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DataSourceControllerApi->create_entity_data_sources: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **json_api_data_source_in_document** | [**JsonApiDataSourceInDocument**](JsonApiDataSourceInDocument.md)| | + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiDataSourceOutDocument**](JsonApiDataSourceOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_entity_data_sources** +> delete_entity_data_sources(id) + +Delete Data Source entity + +Data Source - represents data source for the workspace + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import data_source_controller_api +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = data_source_controller_api.DataSourceControllerApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + filter = "name==someString;type==DatabaseTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Delete Data Source entity + api_instance.delete_entity_data_sources(id) + except gooddata_api_client.ApiException as e: + print("Exception when calling DataSourceControllerApi->delete_entity_data_sources: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete Data Source entity + api_instance.delete_entity_data_sources(id, filter=filter) + except gooddata_api_client.ApiException as e: + print("Exception when calling DataSourceControllerApi->delete_entity_data_sources: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successfully deleted | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_entities_data_sources** +> JsonApiDataSourceOutList get_all_entities_data_sources() + +Get Data Source entities + +Data Source - represents data source for the workspace + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import data_source_controller_api +from gooddata_api_client.model.json_api_data_source_out_list import JsonApiDataSourceOutList +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = data_source_controller_api.DataSourceControllerApi(api_client) + filter = "name==someString;type==DatabaseTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = [ + "metaInclude=permissions,page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Data Source entities + api_response = api_instance.get_all_entities_data_sources(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DataSourceControllerApi->get_all_entities_data_sources: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiDataSourceOutList**](JsonApiDataSourceOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_data_sources** +> JsonApiDataSourceOutDocument get_entity_data_sources(id) + +Get Data Source entity + +Data Source - represents data source for the workspace + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import data_source_controller_api +from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = data_source_controller_api.DataSourceControllerApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + filter = "name==someString;type==DatabaseTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + meta_include = [ + "metaInclude=permissions,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get Data Source entity + api_response = api_instance.get_entity_data_sources(id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DataSourceControllerApi->get_entity_data_sources: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Data Source entity + api_response = api_instance.get_entity_data_sources(id, filter=filter, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DataSourceControllerApi->get_entity_data_sources: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiDataSourceOutDocument**](JsonApiDataSourceOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **patch_entity_data_sources** +> JsonApiDataSourceOutDocument patch_entity_data_sources(id, json_api_data_source_patch_document) + +Patch Data Source entity + +Data Source - represents data source for the workspace + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import data_source_controller_api +from gooddata_api_client.model.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument +from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = data_source_controller_api.DataSourceControllerApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + json_api_data_source_patch_document = JsonApiDataSourcePatchDocument( + data=JsonApiDataSourcePatch( + attributes=JsonApiDataSourcePatchAttributes( + alternative_data_source_id="pg_local_docker-demo2", + cache_strategy="ALWAYS", + client_id="client_id_example", + client_secret="client_secret_example", + name="name_example", + parameters=[ + JsonApiDataSourceInAttributesParametersInner( + name="name_example", + value="value_example", + ), + ], + password="password_example", + private_key="private_key_example", + private_key_passphrase="private_key_passphrase_example", + schema="schema_example", + token="token_example", + type="POSTGRESQL", + url="url_example", + username="username_example", + ), + id="id1", + type="dataSource", + ), + ) # JsonApiDataSourcePatchDocument | + filter = "name==someString;type==DatabaseTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Patch Data Source entity + api_response = api_instance.patch_entity_data_sources(id, json_api_data_source_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DataSourceControllerApi->patch_entity_data_sources: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch Data Source entity + api_response = api_instance.patch_entity_data_sources(id, json_api_data_source_patch_document, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DataSourceControllerApi->patch_entity_data_sources: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **json_api_data_source_patch_document** | [**JsonApiDataSourcePatchDocument**](JsonApiDataSourcePatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiDataSourceOutDocument**](JsonApiDataSourceOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_entity_data_sources** +> JsonApiDataSourceOutDocument update_entity_data_sources(id, json_api_data_source_in_document) + +Put Data Source entity + +Data Source - represents data source for the workspace + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import data_source_controller_api +from gooddata_api_client.model.json_api_data_source_in_document import JsonApiDataSourceInDocument +from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = data_source_controller_api.DataSourceControllerApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + json_api_data_source_in_document = JsonApiDataSourceInDocument( + data=JsonApiDataSourceIn( + attributes=JsonApiDataSourceInAttributes( + alternative_data_source_id="pg_local_docker-demo2", + cache_strategy="ALWAYS", + client_id="client_id_example", + client_secret="client_secret_example", + name="name_example", + parameters=[ + JsonApiDataSourceInAttributesParametersInner( + name="name_example", + value="value_example", + ), + ], + password="password_example", + private_key="private_key_example", + private_key_passphrase="private_key_passphrase_example", + schema="schema_example", + token="token_example", + type="POSTGRESQL", + url="url_example", + username="username_example", + ), + id="id1", + type="dataSource", + ), + ) # JsonApiDataSourceInDocument | + filter = "name==someString;type==DatabaseTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Put Data Source entity + api_response = api_instance.update_entity_data_sources(id, json_api_data_source_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DataSourceControllerApi->update_entity_data_sources: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put Data Source entity + api_response = api_instance.update_entity_data_sources(id, json_api_data_source_in_document, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DataSourceControllerApi->update_entity_data_sources: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **json_api_data_source_in_document** | [**JsonApiDataSourceInDocument**](JsonApiDataSourceInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiDataSourceOutDocument**](JsonApiDataSourceOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/gooddata-api-client/docs/DatasetControllerApi.md b/gooddata-api-client/docs/DatasetControllerApi.md new file mode 100644 index 000000000..6886b46c2 --- /dev/null +++ b/gooddata-api-client/docs/DatasetControllerApi.md @@ -0,0 +1,392 @@ +# gooddata_api_client.DatasetControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_all_entities_datasets**](DatasetControllerApi.md#get_all_entities_datasets) | **GET** /api/v1/entities/workspaces/{workspaceId}/datasets | Get all Datasets +[**get_entity_datasets**](DatasetControllerApi.md#get_entity_datasets) | **GET** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Get a Dataset +[**patch_entity_datasets**](DatasetControllerApi.md#patch_entity_datasets) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Patch a Dataset (beta) +[**search_entities_datasets**](DatasetControllerApi.md#search_entities_datasets) | **POST** /api/v1/entities/workspaces/{workspaceId}/datasets/search | The search endpoint (beta) + + +# **get_all_entities_datasets** +> JsonApiDatasetOutList get_all_entities_datasets(workspace_id) + +Get all Datasets + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import dataset_controller_api +from gooddata_api_client.model.json_api_dataset_out_list import JsonApiDatasetOutList +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = dataset_controller_api.DatasetControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "attributes,facts,aggregatedFacts,references,workspaceDataFilters", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get all Datasets + api_response = api_instance.get_all_entities_datasets(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DatasetControllerApi->get_all_entities_datasets: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Datasets + api_response = api_instance.get_all_entities_datasets(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DatasetControllerApi->get_all_entities_datasets: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiDatasetOutList**](JsonApiDatasetOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_datasets** +> JsonApiDatasetOutDocument get_entity_datasets(workspace_id, object_id) + +Get a Dataset + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import dataset_controller_api +from gooddata_api_client.model.json_api_dataset_out_document import JsonApiDatasetOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = dataset_controller_api.DatasetControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "attributes,facts,aggregatedFacts,references,workspaceDataFilters", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a Dataset + api_response = api_instance.get_entity_datasets(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DatasetControllerApi->get_entity_datasets: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Dataset + api_response = api_instance.get_entity_datasets(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DatasetControllerApi->get_entity_datasets: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiDatasetOutDocument**](JsonApiDatasetOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **patch_entity_datasets** +> JsonApiDatasetOutDocument patch_entity_datasets(workspace_id, object_id, json_api_dataset_patch_document) + +Patch a Dataset (beta) + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import dataset_controller_api +from gooddata_api_client.model.json_api_dataset_out_document import JsonApiDatasetOutDocument +from gooddata_api_client.model.json_api_dataset_patch_document import JsonApiDatasetPatchDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = dataset_controller_api.DatasetControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_dataset_patch_document = JsonApiDatasetPatchDocument( + data=JsonApiDatasetPatch( + attributes=JsonApiAttributePatchAttributes( + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="dataset", + ), + ) # JsonApiDatasetPatchDocument | + filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "attributes,facts,aggregatedFacts,references,workspaceDataFilters", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Patch a Dataset (beta) + api_response = api_instance.patch_entity_datasets(workspace_id, object_id, json_api_dataset_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DatasetControllerApi->patch_entity_datasets: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch a Dataset (beta) + api_response = api_instance.patch_entity_datasets(workspace_id, object_id, json_api_dataset_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DatasetControllerApi->patch_entity_datasets: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_dataset_patch_document** | [**JsonApiDatasetPatchDocument**](JsonApiDatasetPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiDatasetOutDocument**](JsonApiDatasetOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **search_entities_datasets** +> JsonApiDatasetOutList search_entities_datasets(workspace_id, entity_search_body) + +The search endpoint (beta) + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import dataset_controller_api +from gooddata_api_client.model.json_api_dataset_out_list import JsonApiDatasetOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = dataset_controller_api.DatasetControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + entity_search_body = EntitySearchBody( + filter="filter_example", + include=[ + "include_example", + ], + meta_include=[ + "meta_include_example", + ], + page=EntitySearchPage( + index=0, + size=100, + ), + sort=[ + EntitySearchSort( + direction="ASC", + _property="_property_example", + ), + ], + ) # EntitySearchBody | Search request body with filter, pagination, and sorting options + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_datasets(workspace_id, entity_search_body) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DatasetControllerApi->search_entities_datasets: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_datasets(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DatasetControllerApi->search_entities_datasets: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + +### Return type + +[**JsonApiDatasetOutList**](JsonApiDatasetOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/gooddata-api-client/docs/DatasetsApi.md b/gooddata-api-client/docs/DatasetsApi.md index 6aec450c1..1fc72d619 100644 --- a/gooddata-api-client/docs/DatasetsApi.md +++ b/gooddata-api-client/docs/DatasetsApi.md @@ -7,7 +7,7 @@ Method | HTTP request | Description [**get_all_entities_datasets**](DatasetsApi.md#get_all_entities_datasets) | **GET** /api/v1/entities/workspaces/{workspaceId}/datasets | Get all Datasets [**get_entity_datasets**](DatasetsApi.md#get_entity_datasets) | **GET** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Get a Dataset [**patch_entity_datasets**](DatasetsApi.md#patch_entity_datasets) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Patch a Dataset (beta) -[**search_entities_datasets**](DatasetsApi.md#search_entities_datasets) | **POST** /api/v1/entities/workspaces/{workspaceId}/datasets/search | Search request for Dataset +[**search_entities_datasets**](DatasetsApi.md#search_entities_datasets) | **POST** /api/v1/entities/workspaces/{workspaceId}/datasets/search | The search endpoint (beta) # **get_all_entities_datasets** @@ -294,7 +294,7 @@ No authorization required # **search_entities_datasets** > JsonApiDatasetOutList search_entities_datasets(workspace_id, entity_search_body) -Search request for Dataset +The search endpoint (beta) ### Example @@ -342,7 +342,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Search request for Dataset + # The search endpoint (beta) api_response = api_instance.search_entities_datasets(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -351,7 +351,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Search request for Dataset + # The search endpoint (beta) api_response = api_instance.search_entities_datasets(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/EntitiesApi.md b/gooddata-api-client/docs/EntitiesApi.md index 6216829ff..f929d314c 100644 --- a/gooddata-api-client/docs/EntitiesApi.md +++ b/gooddata-api-client/docs/EntitiesApi.md @@ -11,7 +11,7 @@ Method | HTTP request | Description [**create_entity_color_palettes**](EntitiesApi.md#create_entity_color_palettes) | **POST** /api/v1/entities/colorPalettes | Post Color Pallettes [**create_entity_csp_directives**](EntitiesApi.md#create_entity_csp_directives) | **POST** /api/v1/entities/cspDirectives | Post CSP Directives [**create_entity_custom_application_settings**](EntitiesApi.md#create_entity_custom_application_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings | Post Custom Application Settings -[**create_entity_custom_geo_collections**](EntitiesApi.md#create_entity_custom_geo_collections) | **POST** /api/v1/entities/customGeoCollections | +[**create_entity_custom_geo_collections**](EntitiesApi.md#create_entity_custom_geo_collections) | **POST** /api/v1/entities/customGeoCollections | Post Custom Geo Collections [**create_entity_dashboard_plugins**](EntitiesApi.md#create_entity_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins | Post Plugins [**create_entity_data_sources**](EntitiesApi.md#create_entity_data_sources) | **POST** /api/v1/entities/dataSources | Post Data Sources [**create_entity_export_definitions**](EntitiesApi.md#create_entity_export_definitions) | **POST** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions | Post Export Definitions @@ -44,7 +44,7 @@ Method | HTTP request | Description [**delete_entity_color_palettes**](EntitiesApi.md#delete_entity_color_palettes) | **DELETE** /api/v1/entities/colorPalettes/{id} | Delete a Color Pallette [**delete_entity_csp_directives**](EntitiesApi.md#delete_entity_csp_directives) | **DELETE** /api/v1/entities/cspDirectives/{id} | Delete CSP Directives [**delete_entity_custom_application_settings**](EntitiesApi.md#delete_entity_custom_application_settings) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Delete a Custom Application Setting -[**delete_entity_custom_geo_collections**](EntitiesApi.md#delete_entity_custom_geo_collections) | **DELETE** /api/v1/entities/customGeoCollections/{id} | +[**delete_entity_custom_geo_collections**](EntitiesApi.md#delete_entity_custom_geo_collections) | **DELETE** /api/v1/entities/customGeoCollections/{id} | Delete Custom Geo Collection [**delete_entity_dashboard_plugins**](EntitiesApi.md#delete_entity_dashboard_plugins) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Delete a Plugin [**delete_entity_data_sources**](EntitiesApi.md#delete_entity_data_sources) | **DELETE** /api/v1/entities/dataSources/{id} | Delete Data Source entity [**delete_entity_export_definitions**](EntitiesApi.md#delete_entity_export_definitions) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Delete an Export Definition @@ -80,7 +80,7 @@ Method | HTTP request | Description [**get_all_entities_color_palettes**](EntitiesApi.md#get_all_entities_color_palettes) | **GET** /api/v1/entities/colorPalettes | Get all Color Pallettes [**get_all_entities_csp_directives**](EntitiesApi.md#get_all_entities_csp_directives) | **GET** /api/v1/entities/cspDirectives | Get CSP Directives [**get_all_entities_custom_application_settings**](EntitiesApi.md#get_all_entities_custom_application_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings | Get all Custom Application Settings -[**get_all_entities_custom_geo_collections**](EntitiesApi.md#get_all_entities_custom_geo_collections) | **GET** /api/v1/entities/customGeoCollections | +[**get_all_entities_custom_geo_collections**](EntitiesApi.md#get_all_entities_custom_geo_collections) | **GET** /api/v1/entities/customGeoCollections | Get all Custom Geo Collections [**get_all_entities_dashboard_plugins**](EntitiesApi.md#get_all_entities_dashboard_plugins) | **GET** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins | Get all Plugins [**get_all_entities_data_source_identifiers**](EntitiesApi.md#get_all_entities_data_source_identifiers) | **GET** /api/v1/entities/dataSourceIdentifiers | Get all Data Source Identifiers [**get_all_entities_data_sources**](EntitiesApi.md#get_all_entities_data_sources) | **GET** /api/v1/entities/dataSources | Get Data Source entities @@ -125,7 +125,7 @@ Method | HTTP request | Description [**get_entity_cookie_security_configurations**](EntitiesApi.md#get_entity_cookie_security_configurations) | **GET** /api/v1/entities/admin/cookieSecurityConfigurations/{id} | Get CookieSecurityConfiguration [**get_entity_csp_directives**](EntitiesApi.md#get_entity_csp_directives) | **GET** /api/v1/entities/cspDirectives/{id} | Get CSP Directives [**get_entity_custom_application_settings**](EntitiesApi.md#get_entity_custom_application_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Get a Custom Application Setting -[**get_entity_custom_geo_collections**](EntitiesApi.md#get_entity_custom_geo_collections) | **GET** /api/v1/entities/customGeoCollections/{id} | +[**get_entity_custom_geo_collections**](EntitiesApi.md#get_entity_custom_geo_collections) | **GET** /api/v1/entities/customGeoCollections/{id} | Get Custom Geo Collection [**get_entity_dashboard_plugins**](EntitiesApi.md#get_entity_dashboard_plugins) | **GET** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Get a Plugin [**get_entity_data_source_identifiers**](EntitiesApi.md#get_entity_data_source_identifiers) | **GET** /api/v1/entities/dataSourceIdentifiers/{id} | Get Data Source Identifier [**get_entity_data_sources**](EntitiesApi.md#get_entity_data_sources) | **GET** /api/v1/entities/dataSources/{id} | Get Data Source entity @@ -168,7 +168,7 @@ Method | HTTP request | Description [**patch_entity_cookie_security_configurations**](EntitiesApi.md#patch_entity_cookie_security_configurations) | **PATCH** /api/v1/entities/admin/cookieSecurityConfigurations/{id} | Patch CookieSecurityConfiguration [**patch_entity_csp_directives**](EntitiesApi.md#patch_entity_csp_directives) | **PATCH** /api/v1/entities/cspDirectives/{id} | Patch CSP Directives [**patch_entity_custom_application_settings**](EntitiesApi.md#patch_entity_custom_application_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Patch a Custom Application Setting -[**patch_entity_custom_geo_collections**](EntitiesApi.md#patch_entity_custom_geo_collections) | **PATCH** /api/v1/entities/customGeoCollections/{id} | +[**patch_entity_custom_geo_collections**](EntitiesApi.md#patch_entity_custom_geo_collections) | **PATCH** /api/v1/entities/customGeoCollections/{id} | Patch Custom Geo Collection [**patch_entity_dashboard_plugins**](EntitiesApi.md#patch_entity_dashboard_plugins) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Patch a Plugin [**patch_entity_data_sources**](EntitiesApi.md#patch_entity_data_sources) | **PATCH** /api/v1/entities/dataSources/{id} | Patch Data Source entity [**patch_entity_datasets**](EntitiesApi.md#patch_entity_datasets) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Patch a Dataset (beta) @@ -198,27 +198,27 @@ Method | HTTP request | Description [**patch_entity_workspace_settings**](EntitiesApi.md#patch_entity_workspace_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Patch a Setting for Workspace [**patch_entity_workspaces**](EntitiesApi.md#patch_entity_workspaces) | **PATCH** /api/v1/entities/workspaces/{id} | Patch Workspace entity [**search_entities_aggregated_facts**](EntitiesApi.md#search_entities_aggregated_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/search | Search request for AggregatedFact -[**search_entities_analytical_dashboards**](EntitiesApi.md#search_entities_analytical_dashboards) | **POST** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search | Search request for AnalyticalDashboard -[**search_entities_attribute_hierarchies**](EntitiesApi.md#search_entities_attribute_hierarchies) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search | Search request for AttributeHierarchy -[**search_entities_attributes**](EntitiesApi.md#search_entities_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributes/search | Search request for Attribute +[**search_entities_analytical_dashboards**](EntitiesApi.md#search_entities_analytical_dashboards) | **POST** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search | The search endpoint (beta) +[**search_entities_attribute_hierarchies**](EntitiesApi.md#search_entities_attribute_hierarchies) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search | The search endpoint (beta) +[**search_entities_attributes**](EntitiesApi.md#search_entities_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributes/search | The search endpoint (beta) [**search_entities_automation_results**](EntitiesApi.md#search_entities_automation_results) | **POST** /api/v1/entities/workspaces/{workspaceId}/automationResults/search | Search request for AutomationResult -[**search_entities_automations**](EntitiesApi.md#search_entities_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations/search | Search request for Automation -[**search_entities_custom_application_settings**](EntitiesApi.md#search_entities_custom_application_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search | Search request for CustomApplicationSetting -[**search_entities_dashboard_plugins**](EntitiesApi.md#search_entities_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search | Search request for DashboardPlugin -[**search_entities_datasets**](EntitiesApi.md#search_entities_datasets) | **POST** /api/v1/entities/workspaces/{workspaceId}/datasets/search | Search request for Dataset -[**search_entities_export_definitions**](EntitiesApi.md#search_entities_export_definitions) | **POST** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/search | Search request for ExportDefinition -[**search_entities_facts**](EntitiesApi.md#search_entities_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/facts/search | Search request for Fact -[**search_entities_filter_contexts**](EntitiesApi.md#search_entities_filter_contexts) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterContexts/search | Search request for FilterContext -[**search_entities_filter_views**](EntitiesApi.md#search_entities_filter_views) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterViews/search | Search request for FilterView -[**search_entities_knowledge_recommendations**](EntitiesApi.md#search_entities_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search | -[**search_entities_labels**](EntitiesApi.md#search_entities_labels) | **POST** /api/v1/entities/workspaces/{workspaceId}/labels/search | Search request for Label +[**search_entities_automations**](EntitiesApi.md#search_entities_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations/search | The search endpoint (beta) +[**search_entities_custom_application_settings**](EntitiesApi.md#search_entities_custom_application_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search | The search endpoint (beta) +[**search_entities_dashboard_plugins**](EntitiesApi.md#search_entities_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search | The search endpoint (beta) +[**search_entities_datasets**](EntitiesApi.md#search_entities_datasets) | **POST** /api/v1/entities/workspaces/{workspaceId}/datasets/search | The search endpoint (beta) +[**search_entities_export_definitions**](EntitiesApi.md#search_entities_export_definitions) | **POST** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/search | The search endpoint (beta) +[**search_entities_facts**](EntitiesApi.md#search_entities_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/facts/search | The search endpoint (beta) +[**search_entities_filter_contexts**](EntitiesApi.md#search_entities_filter_contexts) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterContexts/search | The search endpoint (beta) +[**search_entities_filter_views**](EntitiesApi.md#search_entities_filter_views) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterViews/search | The search endpoint (beta) +[**search_entities_knowledge_recommendations**](EntitiesApi.md#search_entities_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search | The search endpoint (beta) +[**search_entities_labels**](EntitiesApi.md#search_entities_labels) | **POST** /api/v1/entities/workspaces/{workspaceId}/labels/search | The search endpoint (beta) [**search_entities_memory_items**](EntitiesApi.md#search_entities_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems/search | Search request for MemoryItem -[**search_entities_metrics**](EntitiesApi.md#search_entities_metrics) | **POST** /api/v1/entities/workspaces/{workspaceId}/metrics/search | Search request for Metric -[**search_entities_user_data_filters**](EntitiesApi.md#search_entities_user_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/search | Search request for UserDataFilter -[**search_entities_visualization_objects**](EntitiesApi.md#search_entities_visualization_objects) | **POST** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/search | Search request for VisualizationObject -[**search_entities_workspace_data_filter_settings**](EntitiesApi.md#search_entities_workspace_data_filter_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/search | Search request for WorkspaceDataFilterSetting -[**search_entities_workspace_data_filters**](EntitiesApi.md#search_entities_workspace_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/search | Search request for WorkspaceDataFilter -[**search_entities_workspace_settings**](EntitiesApi.md#search_entities_workspace_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/search | +[**search_entities_metrics**](EntitiesApi.md#search_entities_metrics) | **POST** /api/v1/entities/workspaces/{workspaceId}/metrics/search | The search endpoint (beta) +[**search_entities_user_data_filters**](EntitiesApi.md#search_entities_user_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/search | The search endpoint (beta) +[**search_entities_visualization_objects**](EntitiesApi.md#search_entities_visualization_objects) | **POST** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/search | The search endpoint (beta) +[**search_entities_workspace_data_filter_settings**](EntitiesApi.md#search_entities_workspace_data_filter_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/search | The search endpoint (beta) +[**search_entities_workspace_data_filters**](EntitiesApi.md#search_entities_workspace_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/search | The search endpoint (beta) +[**search_entities_workspace_settings**](EntitiesApi.md#search_entities_workspace_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/search | The search endpoint (beta) [**update_entity_analytical_dashboards**](EntitiesApi.md#update_entity_analytical_dashboards) | **PUT** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Put Dashboards [**update_entity_attribute_hierarchies**](EntitiesApi.md#update_entity_attribute_hierarchies) | **PUT** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Put an Attribute Hierarchy [**update_entity_automations**](EntitiesApi.md#update_entity_automations) | **PUT** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Put an Automation @@ -226,7 +226,7 @@ Method | HTTP request | Description [**update_entity_cookie_security_configurations**](EntitiesApi.md#update_entity_cookie_security_configurations) | **PUT** /api/v1/entities/admin/cookieSecurityConfigurations/{id} | Put CookieSecurityConfiguration [**update_entity_csp_directives**](EntitiesApi.md#update_entity_csp_directives) | **PUT** /api/v1/entities/cspDirectives/{id} | Put CSP Directives [**update_entity_custom_application_settings**](EntitiesApi.md#update_entity_custom_application_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Put a Custom Application Setting -[**update_entity_custom_geo_collections**](EntitiesApi.md#update_entity_custom_geo_collections) | **PUT** /api/v1/entities/customGeoCollections/{id} | +[**update_entity_custom_geo_collections**](EntitiesApi.md#update_entity_custom_geo_collections) | **PUT** /api/v1/entities/customGeoCollections/{id} | Put Custom Geo Collection [**update_entity_dashboard_plugins**](EntitiesApi.md#update_entity_dashboard_plugins) | **PUT** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Put a Plugin [**update_entity_data_sources**](EntitiesApi.md#update_entity_data_sources) | **PUT** /api/v1/entities/dataSources/{id} | Put Data Source entity [**update_entity_export_definitions**](EntitiesApi.md#update_entity_export_definitions) | **PUT** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Put an Export Definition @@ -757,6 +757,7 @@ with gooddata_api_client.ApiClient() as api_client: settings=Settings( delimiter="U", export_info=True, + grand_totals_position="pinnedBottom", merge_headers=True, page_orientation="PORTRAIT", page_size="A4", @@ -1128,7 +1129,7 @@ No authorization required # **create_entity_custom_geo_collections** > JsonApiCustomGeoCollectionOutDocument create_entity_custom_geo_collections(json_api_custom_geo_collection_in_document) - +Post Custom Geo Collections ### Example @@ -1164,6 +1165,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: + # Post Custom Geo Collections api_response = api_instance.create_entity_custom_geo_collections(json_api_custom_geo_collection_in_document) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -4160,7 +4162,7 @@ No authorization required # **delete_entity_custom_geo_collections** > delete_entity_custom_geo_collections(id) - +Delete Custom Geo Collection ### Example @@ -4186,6 +4188,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: + # Delete Custom Geo Collection api_instance.delete_entity_custom_geo_collections(id) except gooddata_api_client.ApiException as e: print("Exception when calling EntitiesApi->delete_entity_custom_geo_collections: %s\n" % e) @@ -4193,6 +4196,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: + # Delete Custom Geo Collection api_instance.delete_entity_custom_geo_collections(id, filter=filter) except gooddata_api_client.ApiException as e: print("Exception when calling EntitiesApi->delete_entity_custom_geo_collections: %s\n" % e) @@ -6984,7 +6988,7 @@ No authorization required # **get_all_entities_custom_geo_collections** > JsonApiCustomGeoCollectionOutList get_all_entities_custom_geo_collections() - +Get all Custom Geo Collections ### Example @@ -7019,6 +7023,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: + # Get all Custom Geo Collections api_response = api_instance.get_all_entities_custom_geo_collections(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -10808,7 +10813,7 @@ No authorization required # **get_entity_custom_geo_collections** > JsonApiCustomGeoCollectionOutDocument get_entity_custom_geo_collections(id) - +Get Custom Geo Collection ### Example @@ -10835,6 +10840,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: + # Get Custom Geo Collection api_response = api_instance.get_entity_custom_geo_collections(id) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -10843,6 +10849,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: + # Get Custom Geo Collection api_response = api_instance.get_entity_custom_geo_collections(id, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -14201,6 +14208,7 @@ with gooddata_api_client.ApiClient() as api_client: settings=Settings( delimiter="U", export_info=True, + grand_totals_position="pinnedBottom", merge_headers=True, page_orientation="PORTRAIT", page_size="A4", @@ -14685,7 +14693,7 @@ No authorization required # **patch_entity_custom_geo_collections** > JsonApiCustomGeoCollectionOutDocument patch_entity_custom_geo_collections(id, json_api_custom_geo_collection_patch_document) - +Patch Custom Geo Collection ### Example @@ -14723,6 +14731,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: + # Patch Custom Geo Collection api_response = api_instance.patch_entity_custom_geo_collections(id, json_api_custom_geo_collection_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -14731,6 +14740,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: + # Patch Custom Geo Collection api_response = api_instance.patch_entity_custom_geo_collections(id, json_api_custom_geo_collection_patch_document, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -16163,7 +16173,7 @@ with gooddata_api_client.ApiClient() as api_client: id = "/6bUUGjjNSwg0_bs" # str | json_api_llm_provider_patch_document = JsonApiLlmProviderPatchDocument( data=JsonApiLlmProviderPatch( - attributes=JsonApiLlmProviderPatchAttributes( + attributes=JsonApiLlmProviderInAttributes( default_model_id="default_model_id_example", description="description_example", models=[ @@ -17737,7 +17747,7 @@ No authorization required # **search_entities_analytical_dashboards** > JsonApiAnalyticalDashboardOutList search_entities_analytical_dashboards(workspace_id, entity_search_body) -Search request for AnalyticalDashboard +The search endpoint (beta) ### Example @@ -17785,7 +17795,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Search request for AnalyticalDashboard + # The search endpoint (beta) api_response = api_instance.search_entities_analytical_dashboards(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -17794,7 +17804,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Search request for AnalyticalDashboard + # The search endpoint (beta) api_response = api_instance.search_entities_analytical_dashboards(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -17836,7 +17846,7 @@ No authorization required # **search_entities_attribute_hierarchies** > JsonApiAttributeHierarchyOutList search_entities_attribute_hierarchies(workspace_id, entity_search_body) -Search request for AttributeHierarchy +The search endpoint (beta) ### Example @@ -17884,7 +17894,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Search request for AttributeHierarchy + # The search endpoint (beta) api_response = api_instance.search_entities_attribute_hierarchies(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -17893,7 +17903,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Search request for AttributeHierarchy + # The search endpoint (beta) api_response = api_instance.search_entities_attribute_hierarchies(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -17935,7 +17945,7 @@ No authorization required # **search_entities_attributes** > JsonApiAttributeOutList search_entities_attributes(workspace_id, entity_search_body) -Search request for Attribute +The search endpoint (beta) ### Example @@ -17983,7 +17993,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Search request for Attribute + # The search endpoint (beta) api_response = api_instance.search_entities_attributes(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -17992,7 +18002,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Search request for Attribute + # The search endpoint (beta) api_response = api_instance.search_entities_attributes(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -18133,7 +18143,7 @@ No authorization required # **search_entities_automations** > JsonApiAutomationOutList search_entities_automations(workspace_id, entity_search_body) -Search request for Automation +The search endpoint (beta) ### Example @@ -18181,7 +18191,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Search request for Automation + # The search endpoint (beta) api_response = api_instance.search_entities_automations(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -18190,7 +18200,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Search request for Automation + # The search endpoint (beta) api_response = api_instance.search_entities_automations(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -18232,7 +18242,7 @@ No authorization required # **search_entities_custom_application_settings** > JsonApiCustomApplicationSettingOutList search_entities_custom_application_settings(workspace_id, entity_search_body) -Search request for CustomApplicationSetting +The search endpoint (beta) ### Example @@ -18280,7 +18290,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Search request for CustomApplicationSetting + # The search endpoint (beta) api_response = api_instance.search_entities_custom_application_settings(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -18289,7 +18299,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Search request for CustomApplicationSetting + # The search endpoint (beta) api_response = api_instance.search_entities_custom_application_settings(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -18331,7 +18341,7 @@ No authorization required # **search_entities_dashboard_plugins** > JsonApiDashboardPluginOutList search_entities_dashboard_plugins(workspace_id, entity_search_body) -Search request for DashboardPlugin +The search endpoint (beta) ### Example @@ -18379,7 +18389,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Search request for DashboardPlugin + # The search endpoint (beta) api_response = api_instance.search_entities_dashboard_plugins(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -18388,7 +18398,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Search request for DashboardPlugin + # The search endpoint (beta) api_response = api_instance.search_entities_dashboard_plugins(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -18430,7 +18440,7 @@ No authorization required # **search_entities_datasets** > JsonApiDatasetOutList search_entities_datasets(workspace_id, entity_search_body) -Search request for Dataset +The search endpoint (beta) ### Example @@ -18478,7 +18488,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Search request for Dataset + # The search endpoint (beta) api_response = api_instance.search_entities_datasets(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -18487,7 +18497,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Search request for Dataset + # The search endpoint (beta) api_response = api_instance.search_entities_datasets(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -18529,7 +18539,7 @@ No authorization required # **search_entities_export_definitions** > JsonApiExportDefinitionOutList search_entities_export_definitions(workspace_id, entity_search_body) -Search request for ExportDefinition +The search endpoint (beta) ### Example @@ -18577,7 +18587,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Search request for ExportDefinition + # The search endpoint (beta) api_response = api_instance.search_entities_export_definitions(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -18586,7 +18596,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Search request for ExportDefinition + # The search endpoint (beta) api_response = api_instance.search_entities_export_definitions(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -18628,7 +18638,7 @@ No authorization required # **search_entities_facts** > JsonApiFactOutList search_entities_facts(workspace_id, entity_search_body) -Search request for Fact +The search endpoint (beta) ### Example @@ -18676,7 +18686,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Search request for Fact + # The search endpoint (beta) api_response = api_instance.search_entities_facts(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -18685,7 +18695,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Search request for Fact + # The search endpoint (beta) api_response = api_instance.search_entities_facts(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -18727,7 +18737,7 @@ No authorization required # **search_entities_filter_contexts** > JsonApiFilterContextOutList search_entities_filter_contexts(workspace_id, entity_search_body) -Search request for FilterContext +The search endpoint (beta) ### Example @@ -18775,7 +18785,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Search request for FilterContext + # The search endpoint (beta) api_response = api_instance.search_entities_filter_contexts(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -18784,7 +18794,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Search request for FilterContext + # The search endpoint (beta) api_response = api_instance.search_entities_filter_contexts(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -18826,7 +18836,7 @@ No authorization required # **search_entities_filter_views** > JsonApiFilterViewOutList search_entities_filter_views(workspace_id, entity_search_body) -Search request for FilterView +The search endpoint (beta) ### Example @@ -18874,7 +18884,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Search request for FilterView + # The search endpoint (beta) api_response = api_instance.search_entities_filter_views(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -18883,7 +18893,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Search request for FilterView + # The search endpoint (beta) api_response = api_instance.search_entities_filter_views(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -18925,7 +18935,7 @@ No authorization required # **search_entities_knowledge_recommendations** > JsonApiKnowledgeRecommendationOutList search_entities_knowledge_recommendations(workspace_id, entity_search_body) - +The search endpoint (beta) ### Example @@ -18973,6 +18983,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: + # The search endpoint (beta) api_response = api_instance.search_entities_knowledge_recommendations(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -18981,6 +18992,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: + # The search endpoint (beta) api_response = api_instance.search_entities_knowledge_recommendations(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -19022,7 +19034,7 @@ No authorization required # **search_entities_labels** > JsonApiLabelOutList search_entities_labels(workspace_id, entity_search_body) -Search request for Label +The search endpoint (beta) ### Example @@ -19070,7 +19082,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Search request for Label + # The search endpoint (beta) api_response = api_instance.search_entities_labels(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -19079,7 +19091,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Search request for Label + # The search endpoint (beta) api_response = api_instance.search_entities_labels(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -19220,7 +19232,7 @@ No authorization required # **search_entities_metrics** > JsonApiMetricOutList search_entities_metrics(workspace_id, entity_search_body) -Search request for Metric +The search endpoint (beta) ### Example @@ -19268,7 +19280,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Search request for Metric + # The search endpoint (beta) api_response = api_instance.search_entities_metrics(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -19277,7 +19289,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Search request for Metric + # The search endpoint (beta) api_response = api_instance.search_entities_metrics(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -19319,7 +19331,7 @@ No authorization required # **search_entities_user_data_filters** > JsonApiUserDataFilterOutList search_entities_user_data_filters(workspace_id, entity_search_body) -Search request for UserDataFilter +The search endpoint (beta) ### Example @@ -19367,7 +19379,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Search request for UserDataFilter + # The search endpoint (beta) api_response = api_instance.search_entities_user_data_filters(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -19376,7 +19388,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Search request for UserDataFilter + # The search endpoint (beta) api_response = api_instance.search_entities_user_data_filters(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -19418,7 +19430,7 @@ No authorization required # **search_entities_visualization_objects** > JsonApiVisualizationObjectOutList search_entities_visualization_objects(workspace_id, entity_search_body) -Search request for VisualizationObject +The search endpoint (beta) ### Example @@ -19466,7 +19478,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Search request for VisualizationObject + # The search endpoint (beta) api_response = api_instance.search_entities_visualization_objects(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -19475,7 +19487,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Search request for VisualizationObject + # The search endpoint (beta) api_response = api_instance.search_entities_visualization_objects(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -19517,7 +19529,7 @@ No authorization required # **search_entities_workspace_data_filter_settings** > JsonApiWorkspaceDataFilterSettingOutList search_entities_workspace_data_filter_settings(workspace_id, entity_search_body) -Search request for WorkspaceDataFilterSetting +The search endpoint (beta) ### Example @@ -19565,7 +19577,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Search request for WorkspaceDataFilterSetting + # The search endpoint (beta) api_response = api_instance.search_entities_workspace_data_filter_settings(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -19574,7 +19586,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Search request for WorkspaceDataFilterSetting + # The search endpoint (beta) api_response = api_instance.search_entities_workspace_data_filter_settings(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -19616,7 +19628,7 @@ No authorization required # **search_entities_workspace_data_filters** > JsonApiWorkspaceDataFilterOutList search_entities_workspace_data_filters(workspace_id, entity_search_body) -Search request for WorkspaceDataFilter +The search endpoint (beta) ### Example @@ -19664,7 +19676,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Search request for WorkspaceDataFilter + # The search endpoint (beta) api_response = api_instance.search_entities_workspace_data_filters(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -19673,7 +19685,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Search request for WorkspaceDataFilter + # The search endpoint (beta) api_response = api_instance.search_entities_workspace_data_filters(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -19715,7 +19727,7 @@ No authorization required # **search_entities_workspace_settings** > JsonApiWorkspaceSettingOutList search_entities_workspace_settings(workspace_id, entity_search_body) - +The search endpoint (beta) ### Example @@ -19763,6 +19775,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: + # The search endpoint (beta) api_response = api_instance.search_entities_workspace_settings(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -19771,6 +19784,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: + # The search endpoint (beta) api_response = api_instance.search_entities_workspace_settings(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -20239,6 +20253,7 @@ with gooddata_api_client.ApiClient() as api_client: settings=Settings( delimiter="U", export_info=True, + grand_totals_position="pinnedBottom", merge_headers=True, page_orientation="PORTRAIT", page_size="A4", @@ -20723,7 +20738,7 @@ No authorization required # **update_entity_custom_geo_collections** > JsonApiCustomGeoCollectionOutDocument update_entity_custom_geo_collections(id, json_api_custom_geo_collection_in_document) - +Put Custom Geo Collection ### Example @@ -20761,6 +20776,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: + # Put Custom Geo Collection api_response = api_instance.update_entity_custom_geo_collections(id, json_api_custom_geo_collection_in_document) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -20769,6 +20785,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: + # Put Custom Geo Collection api_response = api_instance.update_entity_custom_geo_collections(id, json_api_custom_geo_collection_in_document, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/ExportDefinitionControllerApi.md b/gooddata-api-client/docs/ExportDefinitionControllerApi.md new file mode 100644 index 000000000..072a63ff2 --- /dev/null +++ b/gooddata-api-client/docs/ExportDefinitionControllerApi.md @@ -0,0 +1,694 @@ +# gooddata_api_client.ExportDefinitionControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_export_definitions**](ExportDefinitionControllerApi.md#create_entity_export_definitions) | **POST** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions | Post Export Definitions +[**delete_entity_export_definitions**](ExportDefinitionControllerApi.md#delete_entity_export_definitions) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Delete an Export Definition +[**get_all_entities_export_definitions**](ExportDefinitionControllerApi.md#get_all_entities_export_definitions) | **GET** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions | Get all Export Definitions +[**get_entity_export_definitions**](ExportDefinitionControllerApi.md#get_entity_export_definitions) | **GET** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Get an Export Definition +[**patch_entity_export_definitions**](ExportDefinitionControllerApi.md#patch_entity_export_definitions) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Patch an Export Definition +[**search_entities_export_definitions**](ExportDefinitionControllerApi.md#search_entities_export_definitions) | **POST** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/search | The search endpoint (beta) +[**update_entity_export_definitions**](ExportDefinitionControllerApi.md#update_entity_export_definitions) | **PUT** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Put an Export Definition + + +# **create_entity_export_definitions** +> JsonApiExportDefinitionOutDocument create_entity_export_definitions(workspace_id, json_api_export_definition_post_optional_id_document) + +Post Export Definitions + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import export_definition_controller_api +from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument +from gooddata_api_client.model.json_api_export_definition_post_optional_id_document import JsonApiExportDefinitionPostOptionalIdDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = export_definition_controller_api.ExportDefinitionControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + json_api_export_definition_post_optional_id_document = JsonApiExportDefinitionPostOptionalIdDocument( + data=JsonApiExportDefinitionPostOptionalId( + attributes=JsonApiExportDefinitionInAttributes( + are_relations_valid=True, + description="description_example", + request_payload=JsonApiExportDefinitionInAttributesRequestPayload(), + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + relationships=JsonApiExportDefinitionInRelationships( + analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + visualization_object=JsonApiExportDefinitionInRelationshipsVisualizationObject( + data=JsonApiVisualizationObjectToOneLinkage(None), + ), + ), + type="exportDefinition", + ), + ) # JsonApiExportDefinitionPostOptionalIdDocument | + include = [ + "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Export Definitions + api_response = api_instance.create_entity_export_definitions(workspace_id, json_api_export_definition_post_optional_id_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportDefinitionControllerApi->create_entity_export_definitions: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Export Definitions + api_response = api_instance.create_entity_export_definitions(workspace_id, json_api_export_definition_post_optional_id_document, include=include, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportDefinitionControllerApi->create_entity_export_definitions: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_export_definition_post_optional_id_document** | [**JsonApiExportDefinitionPostOptionalIdDocument**](JsonApiExportDefinitionPostOptionalIdDocument.md)| | + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiExportDefinitionOutDocument**](JsonApiExportDefinitionOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_entity_export_definitions** +> delete_entity_export_definitions(workspace_id, object_id) + +Delete an Export Definition + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import export_definition_controller_api +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = export_definition_controller_api.ExportDefinitionControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Delete an Export Definition + api_instance.delete_entity_export_definitions(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportDefinitionControllerApi->delete_entity_export_definitions: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete an Export Definition + api_instance.delete_entity_export_definitions(workspace_id, object_id, filter=filter) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportDefinitionControllerApi->delete_entity_export_definitions: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successfully deleted | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_entities_export_definitions** +> JsonApiExportDefinitionOutList get_all_entities_export_definitions(workspace_id) + +Get all Export Definitions + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import export_definition_controller_api +from gooddata_api_client.model.json_api_export_definition_out_list import JsonApiExportDefinitionOutList +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = export_definition_controller_api.ExportDefinitionControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get all Export Definitions + api_response = api_instance.get_all_entities_export_definitions(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportDefinitionControllerApi->get_all_entities_export_definitions: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Export Definitions + api_response = api_instance.get_all_entities_export_definitions(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportDefinitionControllerApi->get_all_entities_export_definitions: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiExportDefinitionOutList**](JsonApiExportDefinitionOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_export_definitions** +> JsonApiExportDefinitionOutDocument get_entity_export_definitions(workspace_id, object_id) + +Get an Export Definition + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import export_definition_controller_api +from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = export_definition_controller_api.ExportDefinitionControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get an Export Definition + api_response = api_instance.get_entity_export_definitions(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportDefinitionControllerApi->get_entity_export_definitions: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get an Export Definition + api_response = api_instance.get_entity_export_definitions(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportDefinitionControllerApi->get_entity_export_definitions: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiExportDefinitionOutDocument**](JsonApiExportDefinitionOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **patch_entity_export_definitions** +> JsonApiExportDefinitionOutDocument patch_entity_export_definitions(workspace_id, object_id, json_api_export_definition_patch_document) + +Patch an Export Definition + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import export_definition_controller_api +from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument +from gooddata_api_client.model.json_api_export_definition_patch_document import JsonApiExportDefinitionPatchDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = export_definition_controller_api.ExportDefinitionControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_export_definition_patch_document = JsonApiExportDefinitionPatchDocument( + data=JsonApiExportDefinitionPatch( + attributes=JsonApiExportDefinitionInAttributes( + are_relations_valid=True, + description="description_example", + request_payload=JsonApiExportDefinitionInAttributesRequestPayload(), + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + relationships=JsonApiExportDefinitionInRelationships( + analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + visualization_object=JsonApiExportDefinitionInRelationshipsVisualizationObject( + data=JsonApiVisualizationObjectToOneLinkage(None), + ), + ), + type="exportDefinition", + ), + ) # JsonApiExportDefinitionPatchDocument | + filter = "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Patch an Export Definition + api_response = api_instance.patch_entity_export_definitions(workspace_id, object_id, json_api_export_definition_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportDefinitionControllerApi->patch_entity_export_definitions: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch an Export Definition + api_response = api_instance.patch_entity_export_definitions(workspace_id, object_id, json_api_export_definition_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportDefinitionControllerApi->patch_entity_export_definitions: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_export_definition_patch_document** | [**JsonApiExportDefinitionPatchDocument**](JsonApiExportDefinitionPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiExportDefinitionOutDocument**](JsonApiExportDefinitionOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **search_entities_export_definitions** +> JsonApiExportDefinitionOutList search_entities_export_definitions(workspace_id, entity_search_body) + +The search endpoint (beta) + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import export_definition_controller_api +from gooddata_api_client.model.json_api_export_definition_out_list import JsonApiExportDefinitionOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = export_definition_controller_api.ExportDefinitionControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + entity_search_body = EntitySearchBody( + filter="filter_example", + include=[ + "include_example", + ], + meta_include=[ + "meta_include_example", + ], + page=EntitySearchPage( + index=0, + size=100, + ), + sort=[ + EntitySearchSort( + direction="ASC", + _property="_property_example", + ), + ], + ) # EntitySearchBody | Search request body with filter, pagination, and sorting options + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_export_definitions(workspace_id, entity_search_body) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportDefinitionControllerApi->search_entities_export_definitions: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_export_definitions(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportDefinitionControllerApi->search_entities_export_definitions: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + +### Return type + +[**JsonApiExportDefinitionOutList**](JsonApiExportDefinitionOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_entity_export_definitions** +> JsonApiExportDefinitionOutDocument update_entity_export_definitions(workspace_id, object_id, json_api_export_definition_in_document) + +Put an Export Definition + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import export_definition_controller_api +from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument +from gooddata_api_client.model.json_api_export_definition_in_document import JsonApiExportDefinitionInDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = export_definition_controller_api.ExportDefinitionControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_export_definition_in_document = JsonApiExportDefinitionInDocument( + data=JsonApiExportDefinitionIn( + attributes=JsonApiExportDefinitionInAttributes( + are_relations_valid=True, + description="description_example", + request_payload=JsonApiExportDefinitionInAttributesRequestPayload(), + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + relationships=JsonApiExportDefinitionInRelationships( + analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + visualization_object=JsonApiExportDefinitionInRelationshipsVisualizationObject( + data=JsonApiVisualizationObjectToOneLinkage(None), + ), + ), + type="exportDefinition", + ), + ) # JsonApiExportDefinitionInDocument | + filter = "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Put an Export Definition + api_response = api_instance.update_entity_export_definitions(workspace_id, object_id, json_api_export_definition_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportDefinitionControllerApi->update_entity_export_definitions: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put an Export Definition + api_response = api_instance.update_entity_export_definitions(workspace_id, object_id, json_api_export_definition_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportDefinitionControllerApi->update_entity_export_definitions: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_export_definition_in_document** | [**JsonApiExportDefinitionInDocument**](JsonApiExportDefinitionInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiExportDefinitionOutDocument**](JsonApiExportDefinitionOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/gooddata-api-client/docs/ExportDefinitionsApi.md b/gooddata-api-client/docs/ExportDefinitionsApi.md index 7f24fa77a..55f17b7b5 100644 --- a/gooddata-api-client/docs/ExportDefinitionsApi.md +++ b/gooddata-api-client/docs/ExportDefinitionsApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description [**get_all_entities_export_definitions**](ExportDefinitionsApi.md#get_all_entities_export_definitions) | **GET** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions | Get all Export Definitions [**get_entity_export_definitions**](ExportDefinitionsApi.md#get_entity_export_definitions) | **GET** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Get an Export Definition [**patch_entity_export_definitions**](ExportDefinitionsApi.md#patch_entity_export_definitions) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Patch an Export Definition -[**search_entities_export_definitions**](ExportDefinitionsApi.md#search_entities_export_definitions) | **POST** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/search | Search request for ExportDefinition +[**search_entities_export_definitions**](ExportDefinitionsApi.md#search_entities_export_definitions) | **POST** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/search | The search endpoint (beta) [**update_entity_export_definitions**](ExportDefinitionsApi.md#update_entity_export_definitions) | **PUT** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Put an Export Definition @@ -489,7 +489,7 @@ No authorization required # **search_entities_export_definitions** > JsonApiExportDefinitionOutList search_entities_export_definitions(workspace_id, entity_search_body) -Search request for ExportDefinition +The search endpoint (beta) ### Example @@ -537,7 +537,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Search request for ExportDefinition + # The search endpoint (beta) api_response = api_instance.search_entities_export_definitions(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -546,7 +546,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Search request for ExportDefinition + # The search endpoint (beta) api_response = api_instance.search_entities_export_definitions(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/FactControllerApi.md b/gooddata-api-client/docs/FactControllerApi.md new file mode 100644 index 000000000..df90c3c3e --- /dev/null +++ b/gooddata-api-client/docs/FactControllerApi.md @@ -0,0 +1,392 @@ +# gooddata_api_client.FactControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_all_entities_facts**](FactControllerApi.md#get_all_entities_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/facts | Get all Facts +[**get_entity_facts**](FactControllerApi.md#get_entity_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/facts/{objectId} | Get a Fact +[**patch_entity_facts**](FactControllerApi.md#patch_entity_facts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/facts/{objectId} | Patch a Fact (beta) +[**search_entities_facts**](FactControllerApi.md#search_entities_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/facts/search | The search endpoint (beta) + + +# **get_all_entities_facts** +> JsonApiFactOutList get_all_entities_facts(workspace_id) + +Get all Facts + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import fact_controller_api +from gooddata_api_client.model.json_api_fact_out_list import JsonApiFactOutList +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = fact_controller_api.FactControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString;dataset.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "dataset", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get all Facts + api_response = api_instance.get_all_entities_facts(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FactControllerApi->get_all_entities_facts: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Facts + api_response = api_instance.get_all_entities_facts(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FactControllerApi->get_all_entities_facts: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiFactOutList**](JsonApiFactOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_facts** +> JsonApiFactOutDocument get_entity_facts(workspace_id, object_id) + +Get a Fact + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import fact_controller_api +from gooddata_api_client.model.json_api_fact_out_document import JsonApiFactOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = fact_controller_api.FactControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;dataset.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "dataset", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a Fact + api_response = api_instance.get_entity_facts(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FactControllerApi->get_entity_facts: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Fact + api_response = api_instance.get_entity_facts(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FactControllerApi->get_entity_facts: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiFactOutDocument**](JsonApiFactOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **patch_entity_facts** +> JsonApiFactOutDocument patch_entity_facts(workspace_id, object_id, json_api_fact_patch_document) + +Patch a Fact (beta) + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import fact_controller_api +from gooddata_api_client.model.json_api_fact_out_document import JsonApiFactOutDocument +from gooddata_api_client.model.json_api_fact_patch_document import JsonApiFactPatchDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = fact_controller_api.FactControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_fact_patch_document = JsonApiFactPatchDocument( + data=JsonApiFactPatch( + attributes=JsonApiAttributePatchAttributes( + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="fact", + ), + ) # JsonApiFactPatchDocument | + filter = "title==someString;description==someString;dataset.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "dataset", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Patch a Fact (beta) + api_response = api_instance.patch_entity_facts(workspace_id, object_id, json_api_fact_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FactControllerApi->patch_entity_facts: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch a Fact (beta) + api_response = api_instance.patch_entity_facts(workspace_id, object_id, json_api_fact_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FactControllerApi->patch_entity_facts: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_fact_patch_document** | [**JsonApiFactPatchDocument**](JsonApiFactPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiFactOutDocument**](JsonApiFactOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **search_entities_facts** +> JsonApiFactOutList search_entities_facts(workspace_id, entity_search_body) + +The search endpoint (beta) + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import fact_controller_api +from gooddata_api_client.model.json_api_fact_out_list import JsonApiFactOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = fact_controller_api.FactControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + entity_search_body = EntitySearchBody( + filter="filter_example", + include=[ + "include_example", + ], + meta_include=[ + "meta_include_example", + ], + page=EntitySearchPage( + index=0, + size=100, + ), + sort=[ + EntitySearchSort( + direction="ASC", + _property="_property_example", + ), + ], + ) # EntitySearchBody | Search request body with filter, pagination, and sorting options + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_facts(workspace_id, entity_search_body) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FactControllerApi->search_entities_facts: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_facts(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FactControllerApi->search_entities_facts: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + +### Return type + +[**JsonApiFactOutList**](JsonApiFactOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/gooddata-api-client/docs/FactsApi.md b/gooddata-api-client/docs/FactsApi.md index eaea468ce..6ac3585aa 100644 --- a/gooddata-api-client/docs/FactsApi.md +++ b/gooddata-api-client/docs/FactsApi.md @@ -10,7 +10,7 @@ Method | HTTP request | Description [**get_entity_facts**](FactsApi.md#get_entity_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/facts/{objectId} | Get a Fact [**patch_entity_facts**](FactsApi.md#patch_entity_facts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/facts/{objectId} | Patch a Fact (beta) [**search_entities_aggregated_facts**](FactsApi.md#search_entities_aggregated_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/search | Search request for AggregatedFact -[**search_entities_facts**](FactsApi.md#search_entities_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/facts/search | Search request for Fact +[**search_entities_facts**](FactsApi.md#search_entities_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/facts/search | The search endpoint (beta) # **get_all_entities_aggregated_facts** @@ -576,7 +576,7 @@ No authorization required # **search_entities_facts** > JsonApiFactOutList search_entities_facts(workspace_id, entity_search_body) -Search request for Fact +The search endpoint (beta) ### Example @@ -624,7 +624,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Search request for Fact + # The search endpoint (beta) api_response = api_instance.search_entities_facts(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -633,7 +633,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Search request for Fact + # The search endpoint (beta) api_response = api_instance.search_entities_facts(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/FilterContextApi.md b/gooddata-api-client/docs/FilterContextApi.md index f3b9dfdaf..e70416f90 100644 --- a/gooddata-api-client/docs/FilterContextApi.md +++ b/gooddata-api-client/docs/FilterContextApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description [**get_all_entities_filter_contexts**](FilterContextApi.md#get_all_entities_filter_contexts) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterContexts | Get all Filter Context [**get_entity_filter_contexts**](FilterContextApi.md#get_entity_filter_contexts) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Get a Filter Context [**patch_entity_filter_contexts**](FilterContextApi.md#patch_entity_filter_contexts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Patch a Filter Context -[**search_entities_filter_contexts**](FilterContextApi.md#search_entities_filter_contexts) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterContexts/search | Search request for FilterContext +[**search_entities_filter_contexts**](FilterContextApi.md#search_entities_filter_contexts) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterContexts/search | The search endpoint (beta) [**update_entity_filter_contexts**](FilterContextApi.md#update_entity_filter_contexts) | **PUT** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Put a Filter Context @@ -473,7 +473,7 @@ No authorization required # **search_entities_filter_contexts** > JsonApiFilterContextOutList search_entities_filter_contexts(workspace_id, entity_search_body) -Search request for FilterContext +The search endpoint (beta) ### Example @@ -521,7 +521,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Search request for FilterContext + # The search endpoint (beta) api_response = api_instance.search_entities_filter_contexts(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -530,7 +530,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Search request for FilterContext + # The search endpoint (beta) api_response = api_instance.search_entities_filter_contexts(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/FilterContextControllerApi.md b/gooddata-api-client/docs/FilterContextControllerApi.md new file mode 100644 index 000000000..3758102f1 --- /dev/null +++ b/gooddata-api-client/docs/FilterContextControllerApi.md @@ -0,0 +1,670 @@ +# gooddata_api_client.FilterContextControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_filter_contexts**](FilterContextControllerApi.md#create_entity_filter_contexts) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterContexts | Post Filter Context +[**delete_entity_filter_contexts**](FilterContextControllerApi.md#delete_entity_filter_contexts) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Delete a Filter Context +[**get_all_entities_filter_contexts**](FilterContextControllerApi.md#get_all_entities_filter_contexts) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterContexts | Get all Filter Context +[**get_entity_filter_contexts**](FilterContextControllerApi.md#get_entity_filter_contexts) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Get a Filter Context +[**patch_entity_filter_contexts**](FilterContextControllerApi.md#patch_entity_filter_contexts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Patch a Filter Context +[**search_entities_filter_contexts**](FilterContextControllerApi.md#search_entities_filter_contexts) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterContexts/search | The search endpoint (beta) +[**update_entity_filter_contexts**](FilterContextControllerApi.md#update_entity_filter_contexts) | **PUT** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Put a Filter Context + + +# **create_entity_filter_contexts** +> JsonApiFilterContextOutDocument create_entity_filter_contexts(workspace_id, json_api_filter_context_post_optional_id_document) + +Post Filter Context + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import filter_context_controller_api +from gooddata_api_client.model.json_api_filter_context_post_optional_id_document import JsonApiFilterContextPostOptionalIdDocument +from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = filter_context_controller_api.FilterContextControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + json_api_filter_context_post_optional_id_document = JsonApiFilterContextPostOptionalIdDocument( + data=JsonApiFilterContextPostOptionalId( + attributes=JsonApiFilterContextInAttributes( + are_relations_valid=True, + content={}, + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="filterContext", + ), + ) # JsonApiFilterContextPostOptionalIdDocument | + include = [ + "attributes,datasets,labels", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Filter Context + api_response = api_instance.create_entity_filter_contexts(workspace_id, json_api_filter_context_post_optional_id_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterContextControllerApi->create_entity_filter_contexts: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Filter Context + api_response = api_instance.create_entity_filter_contexts(workspace_id, json_api_filter_context_post_optional_id_document, include=include, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterContextControllerApi->create_entity_filter_contexts: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_filter_context_post_optional_id_document** | [**JsonApiFilterContextPostOptionalIdDocument**](JsonApiFilterContextPostOptionalIdDocument.md)| | + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiFilterContextOutDocument**](JsonApiFilterContextOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_entity_filter_contexts** +> delete_entity_filter_contexts(workspace_id, object_id) + +Delete a Filter Context + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import filter_context_controller_api +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = filter_context_controller_api.FilterContextControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Delete a Filter Context + api_instance.delete_entity_filter_contexts(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterContextControllerApi->delete_entity_filter_contexts: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete a Filter Context + api_instance.delete_entity_filter_contexts(workspace_id, object_id, filter=filter) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterContextControllerApi->delete_entity_filter_contexts: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successfully deleted | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_entities_filter_contexts** +> JsonApiFilterContextOutList get_all_entities_filter_contexts(workspace_id) + +Get all Filter Context + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import filter_context_controller_api +from gooddata_api_client.model.json_api_filter_context_out_list import JsonApiFilterContextOutList +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = filter_context_controller_api.FilterContextControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "attributes,datasets,labels", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get all Filter Context + api_response = api_instance.get_all_entities_filter_contexts(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterContextControllerApi->get_all_entities_filter_contexts: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Filter Context + api_response = api_instance.get_all_entities_filter_contexts(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterContextControllerApi->get_all_entities_filter_contexts: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiFilterContextOutList**](JsonApiFilterContextOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_filter_contexts** +> JsonApiFilterContextOutDocument get_entity_filter_contexts(workspace_id, object_id) + +Get a Filter Context + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import filter_context_controller_api +from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = filter_context_controller_api.FilterContextControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "attributes,datasets,labels", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a Filter Context + api_response = api_instance.get_entity_filter_contexts(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterContextControllerApi->get_entity_filter_contexts: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Filter Context + api_response = api_instance.get_entity_filter_contexts(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterContextControllerApi->get_entity_filter_contexts: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiFilterContextOutDocument**](JsonApiFilterContextOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **patch_entity_filter_contexts** +> JsonApiFilterContextOutDocument patch_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_patch_document) + +Patch a Filter Context + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import filter_context_controller_api +from gooddata_api_client.model.json_api_filter_context_patch_document import JsonApiFilterContextPatchDocument +from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = filter_context_controller_api.FilterContextControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_filter_context_patch_document = JsonApiFilterContextPatchDocument( + data=JsonApiFilterContextPatch( + attributes=JsonApiFilterContextPatchAttributes( + are_relations_valid=True, + content={}, + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="filterContext", + ), + ) # JsonApiFilterContextPatchDocument | + filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "attributes,datasets,labels", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Patch a Filter Context + api_response = api_instance.patch_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterContextControllerApi->patch_entity_filter_contexts: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch a Filter Context + api_response = api_instance.patch_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterContextControllerApi->patch_entity_filter_contexts: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_filter_context_patch_document** | [**JsonApiFilterContextPatchDocument**](JsonApiFilterContextPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiFilterContextOutDocument**](JsonApiFilterContextOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **search_entities_filter_contexts** +> JsonApiFilterContextOutList search_entities_filter_contexts(workspace_id, entity_search_body) + +The search endpoint (beta) + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import filter_context_controller_api +from gooddata_api_client.model.json_api_filter_context_out_list import JsonApiFilterContextOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = filter_context_controller_api.FilterContextControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + entity_search_body = EntitySearchBody( + filter="filter_example", + include=[ + "include_example", + ], + meta_include=[ + "meta_include_example", + ], + page=EntitySearchPage( + index=0, + size=100, + ), + sort=[ + EntitySearchSort( + direction="ASC", + _property="_property_example", + ), + ], + ) # EntitySearchBody | Search request body with filter, pagination, and sorting options + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_filter_contexts(workspace_id, entity_search_body) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterContextControllerApi->search_entities_filter_contexts: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_filter_contexts(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterContextControllerApi->search_entities_filter_contexts: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + +### Return type + +[**JsonApiFilterContextOutList**](JsonApiFilterContextOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_entity_filter_contexts** +> JsonApiFilterContextOutDocument update_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_in_document) + +Put a Filter Context + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import filter_context_controller_api +from gooddata_api_client.model.json_api_filter_context_in_document import JsonApiFilterContextInDocument +from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = filter_context_controller_api.FilterContextControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_filter_context_in_document = JsonApiFilterContextInDocument( + data=JsonApiFilterContextIn( + attributes=JsonApiFilterContextInAttributes( + are_relations_valid=True, + content={}, + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="filterContext", + ), + ) # JsonApiFilterContextInDocument | + filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "attributes,datasets,labels", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Put a Filter Context + api_response = api_instance.update_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterContextControllerApi->update_entity_filter_contexts: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put a Filter Context + api_response = api_instance.update_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterContextControllerApi->update_entity_filter_contexts: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_filter_context_in_document** | [**JsonApiFilterContextInDocument**](JsonApiFilterContextInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiFilterContextOutDocument**](JsonApiFilterContextOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/gooddata-api-client/docs/FilterViewControllerApi.md b/gooddata-api-client/docs/FilterViewControllerApi.md new file mode 100644 index 000000000..c70c925ef --- /dev/null +++ b/gooddata-api-client/docs/FilterViewControllerApi.md @@ -0,0 +1,689 @@ +# gooddata_api_client.FilterViewControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_filter_views**](FilterViewControllerApi.md#create_entity_filter_views) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterViews | Post Filter views +[**delete_entity_filter_views**](FilterViewControllerApi.md#delete_entity_filter_views) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Delete Filter view +[**get_all_entities_filter_views**](FilterViewControllerApi.md#get_all_entities_filter_views) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterViews | Get all Filter views +[**get_entity_filter_views**](FilterViewControllerApi.md#get_entity_filter_views) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Get Filter view +[**patch_entity_filter_views**](FilterViewControllerApi.md#patch_entity_filter_views) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Patch Filter view +[**search_entities_filter_views**](FilterViewControllerApi.md#search_entities_filter_views) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterViews/search | The search endpoint (beta) +[**update_entity_filter_views**](FilterViewControllerApi.md#update_entity_filter_views) | **PUT** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Put Filter views + + +# **create_entity_filter_views** +> JsonApiFilterViewOutDocument create_entity_filter_views(workspace_id, json_api_filter_view_in_document) + +Post Filter views + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import filter_view_controller_api +from gooddata_api_client.model.json_api_filter_view_in_document import JsonApiFilterViewInDocument +from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = filter_view_controller_api.FilterViewControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + json_api_filter_view_in_document = JsonApiFilterViewInDocument( + data=JsonApiFilterViewIn( + attributes=JsonApiFilterViewInAttributes( + are_relations_valid=True, + content={}, + description="description_example", + is_default=True, + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + relationships=JsonApiFilterViewInRelationships( + analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + user=JsonApiFilterViewInRelationshipsUser( + data=JsonApiUserToOneLinkage(None), + ), + ), + type="filterView", + ), + ) # JsonApiFilterViewInDocument | + include = [ + "analyticalDashboard,user", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Filter views + api_response = api_instance.create_entity_filter_views(workspace_id, json_api_filter_view_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterViewControllerApi->create_entity_filter_views: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Filter views + api_response = api_instance.create_entity_filter_views(workspace_id, json_api_filter_view_in_document, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterViewControllerApi->create_entity_filter_views: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_filter_view_in_document** | [**JsonApiFilterViewInDocument**](JsonApiFilterViewInDocument.md)| | + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiFilterViewOutDocument**](JsonApiFilterViewOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_entity_filter_views** +> delete_entity_filter_views(workspace_id, object_id) + +Delete Filter view + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import filter_view_controller_api +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = filter_view_controller_api.FilterViewControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;analyticalDashboard.id==321;user.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Delete Filter view + api_instance.delete_entity_filter_views(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterViewControllerApi->delete_entity_filter_views: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete Filter view + api_instance.delete_entity_filter_views(workspace_id, object_id, filter=filter) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterViewControllerApi->delete_entity_filter_views: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successfully deleted | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_entities_filter_views** +> JsonApiFilterViewOutList get_all_entities_filter_views(workspace_id) + +Get all Filter views + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import filter_view_controller_api +from gooddata_api_client.model.json_api_filter_view_out_list import JsonApiFilterViewOutList +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = filter_view_controller_api.FilterViewControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString;analyticalDashboard.id==321;user.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "analyticalDashboard,user", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get all Filter views + api_response = api_instance.get_all_entities_filter_views(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterViewControllerApi->get_all_entities_filter_views: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Filter views + api_response = api_instance.get_all_entities_filter_views(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterViewControllerApi->get_all_entities_filter_views: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiFilterViewOutList**](JsonApiFilterViewOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_filter_views** +> JsonApiFilterViewOutDocument get_entity_filter_views(workspace_id, object_id) + +Get Filter view + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import filter_view_controller_api +from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = filter_view_controller_api.FilterViewControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;analyticalDashboard.id==321;user.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "analyticalDashboard,user", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get Filter view + api_response = api_instance.get_entity_filter_views(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterViewControllerApi->get_entity_filter_views: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Filter view + api_response = api_instance.get_entity_filter_views(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterViewControllerApi->get_entity_filter_views: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + +### Return type + +[**JsonApiFilterViewOutDocument**](JsonApiFilterViewOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **patch_entity_filter_views** +> JsonApiFilterViewOutDocument patch_entity_filter_views(workspace_id, object_id, json_api_filter_view_patch_document) + +Patch Filter view + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import filter_view_controller_api +from gooddata_api_client.model.json_api_filter_view_patch_document import JsonApiFilterViewPatchDocument +from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = filter_view_controller_api.FilterViewControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_filter_view_patch_document = JsonApiFilterViewPatchDocument( + data=JsonApiFilterViewPatch( + attributes=JsonApiFilterViewPatchAttributes( + are_relations_valid=True, + content={}, + description="description_example", + is_default=True, + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + relationships=JsonApiFilterViewInRelationships( + analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + user=JsonApiFilterViewInRelationshipsUser( + data=JsonApiUserToOneLinkage(None), + ), + ), + type="filterView", + ), + ) # JsonApiFilterViewPatchDocument | + filter = "title==someString;description==someString;analyticalDashboard.id==321;user.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "analyticalDashboard,user", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Patch Filter view + api_response = api_instance.patch_entity_filter_views(workspace_id, object_id, json_api_filter_view_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterViewControllerApi->patch_entity_filter_views: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch Filter view + api_response = api_instance.patch_entity_filter_views(workspace_id, object_id, json_api_filter_view_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterViewControllerApi->patch_entity_filter_views: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_filter_view_patch_document** | [**JsonApiFilterViewPatchDocument**](JsonApiFilterViewPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiFilterViewOutDocument**](JsonApiFilterViewOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **search_entities_filter_views** +> JsonApiFilterViewOutList search_entities_filter_views(workspace_id, entity_search_body) + +The search endpoint (beta) + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import filter_view_controller_api +from gooddata_api_client.model.json_api_filter_view_out_list import JsonApiFilterViewOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = filter_view_controller_api.FilterViewControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + entity_search_body = EntitySearchBody( + filter="filter_example", + include=[ + "include_example", + ], + meta_include=[ + "meta_include_example", + ], + page=EntitySearchPage( + index=0, + size=100, + ), + sort=[ + EntitySearchSort( + direction="ASC", + _property="_property_example", + ), + ], + ) # EntitySearchBody | Search request body with filter, pagination, and sorting options + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_filter_views(workspace_id, entity_search_body) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterViewControllerApi->search_entities_filter_views: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_filter_views(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterViewControllerApi->search_entities_filter_views: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + +### Return type + +[**JsonApiFilterViewOutList**](JsonApiFilterViewOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_entity_filter_views** +> JsonApiFilterViewOutDocument update_entity_filter_views(workspace_id, object_id, json_api_filter_view_in_document) + +Put Filter views + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import filter_view_controller_api +from gooddata_api_client.model.json_api_filter_view_in_document import JsonApiFilterViewInDocument +from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = filter_view_controller_api.FilterViewControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_filter_view_in_document = JsonApiFilterViewInDocument( + data=JsonApiFilterViewIn( + attributes=JsonApiFilterViewInAttributes( + are_relations_valid=True, + content={}, + description="description_example", + is_default=True, + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + relationships=JsonApiFilterViewInRelationships( + analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + user=JsonApiFilterViewInRelationshipsUser( + data=JsonApiUserToOneLinkage(None), + ), + ), + type="filterView", + ), + ) # JsonApiFilterViewInDocument | + filter = "title==someString;description==someString;analyticalDashboard.id==321;user.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "analyticalDashboard,user", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Put Filter views + api_response = api_instance.update_entity_filter_views(workspace_id, object_id, json_api_filter_view_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterViewControllerApi->update_entity_filter_views: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put Filter views + api_response = api_instance.update_entity_filter_views(workspace_id, object_id, json_api_filter_view_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterViewControllerApi->update_entity_filter_views: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_filter_view_in_document** | [**JsonApiFilterViewInDocument**](JsonApiFilterViewInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiFilterViewOutDocument**](JsonApiFilterViewOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/gooddata-api-client/docs/FilterViewsApi.md b/gooddata-api-client/docs/FilterViewsApi.md index 8f0bb0b52..63037f271 100644 --- a/gooddata-api-client/docs/FilterViewsApi.md +++ b/gooddata-api-client/docs/FilterViewsApi.md @@ -10,7 +10,7 @@ Method | HTTP request | Description [**get_entity_filter_views**](FilterViewsApi.md#get_entity_filter_views) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Get Filter view [**get_filter_views**](FilterViewsApi.md#get_filter_views) | **GET** /api/v1/layout/workspaces/{workspaceId}/filterViews | Get filter views [**patch_entity_filter_views**](FilterViewsApi.md#patch_entity_filter_views) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Patch Filter view -[**search_entities_filter_views**](FilterViewsApi.md#search_entities_filter_views) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterViews/search | Search request for FilterView +[**search_entities_filter_views**](FilterViewsApi.md#search_entities_filter_views) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterViews/search | The search endpoint (beta) [**set_filter_views**](FilterViewsApi.md#set_filter_views) | **PUT** /api/v1/layout/workspaces/{workspaceId}/filterViews | Set filter views [**update_entity_filter_views**](FilterViewsApi.md#update_entity_filter_views) | **PUT** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Put Filter views @@ -565,7 +565,7 @@ No authorization required # **search_entities_filter_views** > JsonApiFilterViewOutList search_entities_filter_views(workspace_id, entity_search_body) -Search request for FilterView +The search endpoint (beta) ### Example @@ -613,7 +613,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Search request for FilterView + # The search endpoint (beta) api_response = api_instance.search_entities_filter_views(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -622,7 +622,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Search request for FilterView + # The search endpoint (beta) api_response = api_instance.search_entities_filter_views(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/GeographicDataApi.md b/gooddata-api-client/docs/GeographicDataApi.md index 56ca7ec93..edec26af8 100644 --- a/gooddata-api-client/docs/GeographicDataApi.md +++ b/gooddata-api-client/docs/GeographicDataApi.md @@ -4,18 +4,18 @@ All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create_entity_custom_geo_collections**](GeographicDataApi.md#create_entity_custom_geo_collections) | **POST** /api/v1/entities/customGeoCollections | -[**delete_entity_custom_geo_collections**](GeographicDataApi.md#delete_entity_custom_geo_collections) | **DELETE** /api/v1/entities/customGeoCollections/{id} | -[**get_all_entities_custom_geo_collections**](GeographicDataApi.md#get_all_entities_custom_geo_collections) | **GET** /api/v1/entities/customGeoCollections | -[**get_entity_custom_geo_collections**](GeographicDataApi.md#get_entity_custom_geo_collections) | **GET** /api/v1/entities/customGeoCollections/{id} | -[**patch_entity_custom_geo_collections**](GeographicDataApi.md#patch_entity_custom_geo_collections) | **PATCH** /api/v1/entities/customGeoCollections/{id} | -[**update_entity_custom_geo_collections**](GeographicDataApi.md#update_entity_custom_geo_collections) | **PUT** /api/v1/entities/customGeoCollections/{id} | +[**create_entity_custom_geo_collections**](GeographicDataApi.md#create_entity_custom_geo_collections) | **POST** /api/v1/entities/customGeoCollections | Post Custom Geo Collections +[**delete_entity_custom_geo_collections**](GeographicDataApi.md#delete_entity_custom_geo_collections) | **DELETE** /api/v1/entities/customGeoCollections/{id} | Delete Custom Geo Collection +[**get_all_entities_custom_geo_collections**](GeographicDataApi.md#get_all_entities_custom_geo_collections) | **GET** /api/v1/entities/customGeoCollections | Get all Custom Geo Collections +[**get_entity_custom_geo_collections**](GeographicDataApi.md#get_entity_custom_geo_collections) | **GET** /api/v1/entities/customGeoCollections/{id} | Get Custom Geo Collection +[**patch_entity_custom_geo_collections**](GeographicDataApi.md#patch_entity_custom_geo_collections) | **PATCH** /api/v1/entities/customGeoCollections/{id} | Patch Custom Geo Collection +[**update_entity_custom_geo_collections**](GeographicDataApi.md#update_entity_custom_geo_collections) | **PUT** /api/v1/entities/customGeoCollections/{id} | Put Custom Geo Collection # **create_entity_custom_geo_collections** > JsonApiCustomGeoCollectionOutDocument create_entity_custom_geo_collections(json_api_custom_geo_collection_in_document) - +Post Custom Geo Collections ### Example @@ -51,6 +51,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: + # Post Custom Geo Collections api_response = api_instance.create_entity_custom_geo_collections(json_api_custom_geo_collection_in_document) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -89,7 +90,7 @@ No authorization required # **delete_entity_custom_geo_collections** > delete_entity_custom_geo_collections(id) - +Delete Custom Geo Collection ### Example @@ -115,6 +116,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: + # Delete Custom Geo Collection api_instance.delete_entity_custom_geo_collections(id) except gooddata_api_client.ApiException as e: print("Exception when calling GeographicDataApi->delete_entity_custom_geo_collections: %s\n" % e) @@ -122,6 +124,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: + # Delete Custom Geo Collection api_instance.delete_entity_custom_geo_collections(id, filter=filter) except gooddata_api_client.ApiException as e: print("Exception when calling GeographicDataApi->delete_entity_custom_geo_collections: %s\n" % e) @@ -160,7 +163,7 @@ No authorization required # **get_all_entities_custom_geo_collections** > JsonApiCustomGeoCollectionOutList get_all_entities_custom_geo_collections() - +Get all Custom Geo Collections ### Example @@ -195,6 +198,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: + # Get all Custom Geo Collections api_response = api_instance.get_all_entities_custom_geo_collections(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -237,7 +241,7 @@ No authorization required # **get_entity_custom_geo_collections** > JsonApiCustomGeoCollectionOutDocument get_entity_custom_geo_collections(id) - +Get Custom Geo Collection ### Example @@ -264,6 +268,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: + # Get Custom Geo Collection api_response = api_instance.get_entity_custom_geo_collections(id) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -272,6 +277,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: + # Get Custom Geo Collection api_response = api_instance.get_entity_custom_geo_collections(id, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -311,7 +317,7 @@ No authorization required # **patch_entity_custom_geo_collections** > JsonApiCustomGeoCollectionOutDocument patch_entity_custom_geo_collections(id, json_api_custom_geo_collection_patch_document) - +Patch Custom Geo Collection ### Example @@ -349,6 +355,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: + # Patch Custom Geo Collection api_response = api_instance.patch_entity_custom_geo_collections(id, json_api_custom_geo_collection_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -357,6 +364,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: + # Patch Custom Geo Collection api_response = api_instance.patch_entity_custom_geo_collections(id, json_api_custom_geo_collection_patch_document, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -397,7 +405,7 @@ No authorization required # **update_entity_custom_geo_collections** > JsonApiCustomGeoCollectionOutDocument update_entity_custom_geo_collections(id, json_api_custom_geo_collection_in_document) - +Put Custom Geo Collection ### Example @@ -435,6 +443,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: + # Put Custom Geo Collection api_response = api_instance.update_entity_custom_geo_collections(id, json_api_custom_geo_collection_in_document) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -443,6 +452,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: + # Put Custom Geo Collection api_response = api_instance.update_entity_custom_geo_collections(id, json_api_custom_geo_collection_in_document, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/GetServiceStatusResponse.md b/gooddata-api-client/docs/GetServiceStatusResponse.md new file mode 100644 index 000000000..efbedc255 --- /dev/null +++ b/gooddata-api-client/docs/GetServiceStatusResponse.md @@ -0,0 +1,13 @@ +# GetServiceStatusResponse + +Status of an AI Lake service + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | [**JsonNode**](JsonNode.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/InsightWidgetDescriptor.md b/gooddata-api-client/docs/InsightWidgetDescriptor.md new file mode 100644 index 000000000..dbda14ea6 --- /dev/null +++ b/gooddata-api-client/docs/InsightWidgetDescriptor.md @@ -0,0 +1,17 @@ +# InsightWidgetDescriptor + +Insight widget displaying a visualization. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**title** | **str** | Widget title as displayed on the dashboard. | +**visualization_id** | **str** | Visualization object ID referenced by this insight widget. | +**widget_id** | **str** | Widget object ID. | +**widget_type** | **str** | | +**result_id** | **str** | Signed result ID for this widget's cached execution result. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/InsightWidgetDescriptorAllOf.md b/gooddata-api-client/docs/InsightWidgetDescriptorAllOf.md new file mode 100644 index 000000000..2b1758c3a --- /dev/null +++ b/gooddata-api-client/docs/InsightWidgetDescriptorAllOf.md @@ -0,0 +1,15 @@ +# InsightWidgetDescriptorAllOf + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**result_id** | **str** | Signed result ID for this widget's cached execution result. | [optional] +**title** | **str** | Widget title as displayed on the dashboard. | [optional] +**visualization_id** | **str** | Visualization object ID referenced by this insight widget. | [optional] +**widget_id** | **str** | Widget object ID. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/JsonApiLlmProviderIn.md b/gooddata-api-client/docs/JsonApiLlmProviderIn.md index fa9f062c2..8d7025319 100644 --- a/gooddata-api-client/docs/JsonApiLlmProviderIn.md +++ b/gooddata-api-client/docs/JsonApiLlmProviderIn.md @@ -5,9 +5,9 @@ LLM Provider configuration for connecting to LLM services. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**attributes** | [**JsonApiLlmProviderInAttributes**](JsonApiLlmProviderInAttributes.md) | | **id** | **str** | API identifier of an object | **type** | **str** | Object type | defaults to "llmProvider" +**attributes** | [**JsonApiLlmProviderInAttributes**](JsonApiLlmProviderInAttributes.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiLlmProviderInAttributes.md b/gooddata-api-client/docs/JsonApiLlmProviderInAttributes.md index 885d9995d..c3b1b58ee 100644 --- a/gooddata-api-client/docs/JsonApiLlmProviderInAttributes.md +++ b/gooddata-api-client/docs/JsonApiLlmProviderInAttributes.md @@ -4,11 +4,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**models** | [**[JsonApiLlmProviderInAttributesModelsInner], none_type**](JsonApiLlmProviderInAttributesModelsInner.md) | List of LLM models available for this provider. | -**provider_config** | [**JsonApiLlmProviderInAttributesProviderConfig**](JsonApiLlmProviderInAttributesProviderConfig.md) | | -**default_model_id** | **str, none_type** | ID of the default model to use from the models list. | [optional] +**default_model_id** | **str, none_type** | Required ID of the default model to use from the models list. | [optional] **description** | **str, none_type** | Description of the LLM Provider. | [optional] +**models** | [**[JsonApiLlmProviderInAttributesModelsInner], none_type**](JsonApiLlmProviderInAttributesModelsInner.md) | List of LLM models available for this provider. | [optional] **name** | **str, none_type** | | [optional] +**provider_config** | [**JsonApiLlmProviderInAttributesProviderConfig**](JsonApiLlmProviderInAttributesProviderConfig.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiLlmProviderInAttributesProviderConfig.md b/gooddata-api-client/docs/JsonApiLlmProviderInAttributesProviderConfig.md index 40e1a6639..1b2158c42 100644 --- a/gooddata-api-client/docs/JsonApiLlmProviderInAttributesProviderConfig.md +++ b/gooddata-api-client/docs/JsonApiLlmProviderInAttributesProviderConfig.md @@ -5,12 +5,12 @@ Provider-specific configuration including authentication. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**base_url** | **str, none_type** | Custom base URL for OpenAI API. | [optional] if omitted the server will use the default value of "https://api.openai.com" +**base_url** | **str** | Custom base URL for OpenAI API. | [optional] if omitted the server will use the default value of "https://api.openai.com/v1" **organization** | **str, none_type** | OpenAI organization ID. | [optional] **auth** | [**OpenAiProviderAuth**](OpenAiProviderAuth.md) | | [optional] **region** | **str** | AWS region for Bedrock. | [optional] **type** | **str** | Provider type. | [optional] if omitted the server will use the default value of "OPENAI" -**endpoint** | **str** | Azure AI inference endpoint URL. | [optional] +**endpoint** | **str** | Azure OpenAI endpoint URL. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiLlmProviderOut.md b/gooddata-api-client/docs/JsonApiLlmProviderOut.md index 3c0fa41cf..db0060ec4 100644 --- a/gooddata-api-client/docs/JsonApiLlmProviderOut.md +++ b/gooddata-api-client/docs/JsonApiLlmProviderOut.md @@ -5,9 +5,9 @@ LLM Provider configuration for connecting to LLM services. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**attributes** | [**JsonApiLlmProviderInAttributes**](JsonApiLlmProviderInAttributes.md) | | **id** | **str** | API identifier of an object | **type** | **str** | Object type | defaults to "llmProvider" +**attributes** | [**JsonApiLlmProviderInAttributes**](JsonApiLlmProviderInAttributes.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiLlmProviderOutWithLinks.md b/gooddata-api-client/docs/JsonApiLlmProviderOutWithLinks.md index 0e2c3684c..cfb80ab6e 100644 --- a/gooddata-api-client/docs/JsonApiLlmProviderOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiLlmProviderOutWithLinks.md @@ -4,9 +4,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**attributes** | [**JsonApiLlmProviderInAttributes**](JsonApiLlmProviderInAttributes.md) | | **id** | **str** | API identifier of an object | **type** | **str** | Object type | defaults to "llmProvider" +**attributes** | [**JsonApiLlmProviderInAttributes**](JsonApiLlmProviderInAttributes.md) | | [optional] **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/gooddata-api-client/docs/JsonApiLlmProviderPatch.md b/gooddata-api-client/docs/JsonApiLlmProviderPatch.md index 3c6b83a09..9414a59dd 100644 --- a/gooddata-api-client/docs/JsonApiLlmProviderPatch.md +++ b/gooddata-api-client/docs/JsonApiLlmProviderPatch.md @@ -5,9 +5,9 @@ LLM Provider configuration for connecting to LLM services. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**attributes** | [**JsonApiLlmProviderPatchAttributes**](JsonApiLlmProviderPatchAttributes.md) | | **id** | **str** | API identifier of an object | **type** | **str** | Object type | defaults to "llmProvider" +**attributes** | [**JsonApiLlmProviderInAttributes**](JsonApiLlmProviderInAttributes.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiLlmProviderPatchAttributes.md b/gooddata-api-client/docs/JsonApiLlmProviderPatchAttributes.md deleted file mode 100644 index 2d7c3d4a1..000000000 --- a/gooddata-api-client/docs/JsonApiLlmProviderPatchAttributes.md +++ /dev/null @@ -1,16 +0,0 @@ -# JsonApiLlmProviderPatchAttributes - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**default_model_id** | **str, none_type** | ID of the default model to use from the models list. | [optional] -**description** | **str, none_type** | Description of the LLM Provider. | [optional] -**models** | [**[JsonApiLlmProviderInAttributesModelsInner], none_type**](JsonApiLlmProviderInAttributesModelsInner.md) | List of LLM models available for this provider. | [optional] -**name** | **str, none_type** | | [optional] -**provider_config** | [**JsonApiLlmProviderInAttributesProviderConfig**](JsonApiLlmProviderInAttributesProviderConfig.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/JsonApiMetricOutDocument.md b/gooddata-api-client/docs/JsonApiMetricOutDocument.md index 85d95f58b..f538833b5 100644 --- a/gooddata-api-client/docs/JsonApiMetricOutDocument.md +++ b/gooddata-api-client/docs/JsonApiMetricOutDocument.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiMetricOut**](JsonApiMetricOut.md) | | -**included** | [**[JsonApiMetricOutIncludes]**](JsonApiMetricOutIncludes.md) | Included resources | [optional] +**included** | [**[JsonApiVisualizationObjectOutIncludes]**](JsonApiVisualizationObjectOutIncludes.md) | Included resources | [optional] **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/gooddata-api-client/docs/JsonApiMetricOutList.md b/gooddata-api-client/docs/JsonApiMetricOutList.md index 834a4b6ba..89abd91dc 100644 --- a/gooddata-api-client/docs/JsonApiMetricOutList.md +++ b/gooddata-api-client/docs/JsonApiMetricOutList.md @@ -6,7 +6,7 @@ A JSON:API document with a list of resources Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[JsonApiMetricOutWithLinks]**](JsonApiMetricOutWithLinks.md) | | -**included** | [**[JsonApiMetricOutIncludes]**](JsonApiMetricOutIncludes.md) | Included resources | [optional] +**included** | [**[JsonApiVisualizationObjectOutIncludes]**](JsonApiVisualizationObjectOutIncludes.md) | Included resources | [optional] **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/gooddata-api-client/docs/JsonApiVisualizationObjectOutDocument.md b/gooddata-api-client/docs/JsonApiVisualizationObjectOutDocument.md index 72ed05614..f2772fa64 100644 --- a/gooddata-api-client/docs/JsonApiVisualizationObjectOutDocument.md +++ b/gooddata-api-client/docs/JsonApiVisualizationObjectOutDocument.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiVisualizationObjectOut**](JsonApiVisualizationObjectOut.md) | | -**included** | [**[JsonApiMetricOutIncludes]**](JsonApiMetricOutIncludes.md) | Included resources | [optional] +**included** | [**[JsonApiVisualizationObjectOutIncludes]**](JsonApiVisualizationObjectOutIncludes.md) | Included resources | [optional] **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/gooddata-api-client/docs/JsonApiMetricOutIncludes.md b/gooddata-api-client/docs/JsonApiVisualizationObjectOutIncludes.md similarity index 96% rename from gooddata-api-client/docs/JsonApiMetricOutIncludes.md rename to gooddata-api-client/docs/JsonApiVisualizationObjectOutIncludes.md index c447da947..9df8e2c3f 100644 --- a/gooddata-api-client/docs/JsonApiMetricOutIncludes.md +++ b/gooddata-api-client/docs/JsonApiVisualizationObjectOutIncludes.md @@ -1,4 +1,4 @@ -# JsonApiMetricOutIncludes +# JsonApiVisualizationObjectOutIncludes ## Properties diff --git a/gooddata-api-client/docs/JsonApiVisualizationObjectOutList.md b/gooddata-api-client/docs/JsonApiVisualizationObjectOutList.md index 5a79ed4b5..c30b5857f 100644 --- a/gooddata-api-client/docs/JsonApiVisualizationObjectOutList.md +++ b/gooddata-api-client/docs/JsonApiVisualizationObjectOutList.md @@ -6,7 +6,7 @@ A JSON:API document with a list of resources Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[JsonApiVisualizationObjectOutWithLinks]**](JsonApiVisualizationObjectOutWithLinks.md) | | -**included** | [**[JsonApiMetricOutIncludes]**](JsonApiMetricOutIncludes.md) | Included resources | [optional] +**included** | [**[JsonApiVisualizationObjectOutIncludes]**](JsonApiVisualizationObjectOutIncludes.md) | Included resources | [optional] **links** | [**ListLinks**](ListLinks.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/gooddata-api-client/docs/JwkControllerApi.md b/gooddata-api-client/docs/JwkControllerApi.md new file mode 100644 index 000000000..ff65fba27 --- /dev/null +++ b/gooddata-api-client/docs/JwkControllerApi.md @@ -0,0 +1,501 @@ +# gooddata_api_client.JwkControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_jwks**](JwkControllerApi.md#create_entity_jwks) | **POST** /api/v1/entities/jwks | Post Jwks +[**delete_entity_jwks**](JwkControllerApi.md#delete_entity_jwks) | **DELETE** /api/v1/entities/jwks/{id} | Delete Jwk +[**get_all_entities_jwks**](JwkControllerApi.md#get_all_entities_jwks) | **GET** /api/v1/entities/jwks | Get all Jwks +[**get_entity_jwks**](JwkControllerApi.md#get_entity_jwks) | **GET** /api/v1/entities/jwks/{id} | Get Jwk +[**patch_entity_jwks**](JwkControllerApi.md#patch_entity_jwks) | **PATCH** /api/v1/entities/jwks/{id} | Patch Jwk +[**update_entity_jwks**](JwkControllerApi.md#update_entity_jwks) | **PUT** /api/v1/entities/jwks/{id} | Put Jwk + + +# **create_entity_jwks** +> JsonApiJwkOutDocument create_entity_jwks(json_api_jwk_in_document) + +Post Jwks + +Creates JSON web key - used to verify JSON web tokens (Jwts) + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import jwk_controller_api +from gooddata_api_client.model.json_api_jwk_in_document import JsonApiJwkInDocument +from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = jwk_controller_api.JwkControllerApi(api_client) + json_api_jwk_in_document = JsonApiJwkInDocument( + data=JsonApiJwkIn( + attributes=JsonApiJwkInAttributes( + content=JsonApiJwkInAttributesContent(), + ), + id="id1", + type="jwk", + ), + ) # JsonApiJwkInDocument | + + # example passing only required values which don't have defaults set + try: + # Post Jwks + api_response = api_instance.create_entity_jwks(json_api_jwk_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling JwkControllerApi->create_entity_jwks: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **json_api_jwk_in_document** | [**JsonApiJwkInDocument**](JsonApiJwkInDocument.md)| | + +### Return type + +[**JsonApiJwkOutDocument**](JsonApiJwkOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_entity_jwks** +> delete_entity_jwks(id) + +Delete Jwk + +Deletes JSON web key - used to verify JSON web tokens (Jwts) + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import jwk_controller_api +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = jwk_controller_api.JwkControllerApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + filter = "content==JwkSpecificationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Delete Jwk + api_instance.delete_entity_jwks(id) + except gooddata_api_client.ApiException as e: + print("Exception when calling JwkControllerApi->delete_entity_jwks: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete Jwk + api_instance.delete_entity_jwks(id, filter=filter) + except gooddata_api_client.ApiException as e: + print("Exception when calling JwkControllerApi->delete_entity_jwks: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successfully deleted | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_entities_jwks** +> JsonApiJwkOutList get_all_entities_jwks() + +Get all Jwks + +Returns all JSON web keys - used to verify JSON web tokens (Jwts) + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import jwk_controller_api +from gooddata_api_client.model.json_api_jwk_out_list import JsonApiJwkOutList +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = jwk_controller_api.JwkControllerApi(api_client) + filter = "content==JwkSpecificationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = [ + "metaInclude=page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Jwks + api_response = api_instance.get_all_entities_jwks(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling JwkControllerApi->get_all_entities_jwks: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiJwkOutList**](JsonApiJwkOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_jwks** +> JsonApiJwkOutDocument get_entity_jwks(id) + +Get Jwk + +Returns JSON web key - used to verify JSON web tokens (Jwts) + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import jwk_controller_api +from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = jwk_controller_api.JwkControllerApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + filter = "content==JwkSpecificationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Get Jwk + api_response = api_instance.get_entity_jwks(id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling JwkControllerApi->get_entity_jwks: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Jwk + api_response = api_instance.get_entity_jwks(id, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling JwkControllerApi->get_entity_jwks: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiJwkOutDocument**](JsonApiJwkOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **patch_entity_jwks** +> JsonApiJwkOutDocument patch_entity_jwks(id, json_api_jwk_patch_document) + +Patch Jwk + +Patches JSON web key - used to verify JSON web tokens (Jwts) + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import jwk_controller_api +from gooddata_api_client.model.json_api_jwk_patch_document import JsonApiJwkPatchDocument +from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = jwk_controller_api.JwkControllerApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + json_api_jwk_patch_document = JsonApiJwkPatchDocument( + data=JsonApiJwkPatch( + attributes=JsonApiJwkInAttributes( + content=JsonApiJwkInAttributesContent(), + ), + id="id1", + type="jwk", + ), + ) # JsonApiJwkPatchDocument | + filter = "content==JwkSpecificationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Patch Jwk + api_response = api_instance.patch_entity_jwks(id, json_api_jwk_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling JwkControllerApi->patch_entity_jwks: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch Jwk + api_response = api_instance.patch_entity_jwks(id, json_api_jwk_patch_document, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling JwkControllerApi->patch_entity_jwks: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **json_api_jwk_patch_document** | [**JsonApiJwkPatchDocument**](JsonApiJwkPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiJwkOutDocument**](JsonApiJwkOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_entity_jwks** +> JsonApiJwkOutDocument update_entity_jwks(id, json_api_jwk_in_document) + +Put Jwk + +Updates JSON web key - used to verify JSON web tokens (Jwts) + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import jwk_controller_api +from gooddata_api_client.model.json_api_jwk_in_document import JsonApiJwkInDocument +from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = jwk_controller_api.JwkControllerApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + json_api_jwk_in_document = JsonApiJwkInDocument( + data=JsonApiJwkIn( + attributes=JsonApiJwkInAttributes( + content=JsonApiJwkInAttributesContent(), + ), + id="id1", + type="jwk", + ), + ) # JsonApiJwkInDocument | + filter = "content==JwkSpecificationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Put Jwk + api_response = api_instance.update_entity_jwks(id, json_api_jwk_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling JwkControllerApi->update_entity_jwks: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put Jwk + api_response = api_instance.update_entity_jwks(id, json_api_jwk_in_document, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling JwkControllerApi->update_entity_jwks: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **json_api_jwk_in_document** | [**JsonApiJwkInDocument**](JsonApiJwkInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiJwkOutDocument**](JsonApiJwkOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/gooddata-api-client/docs/LLMProvidersApi.md b/gooddata-api-client/docs/LLMProvidersApi.md index fc7558260..0fa3fb2f2 100644 --- a/gooddata-api-client/docs/LLMProvidersApi.md +++ b/gooddata-api-client/docs/LLMProvidersApi.md @@ -353,7 +353,7 @@ with gooddata_api_client.ApiClient() as api_client: id = "/6bUUGjjNSwg0_bs" # str | json_api_llm_provider_patch_document = JsonApiLlmProviderPatchDocument( data=JsonApiLlmProviderPatch( - attributes=JsonApiLlmProviderPatchAttributes( + attributes=JsonApiLlmProviderInAttributes( default_model_id="default_model_id_example", description="description_example", models=[ diff --git a/gooddata-api-client/docs/LabelControllerApi.md b/gooddata-api-client/docs/LabelControllerApi.md new file mode 100644 index 000000000..ef820851e --- /dev/null +++ b/gooddata-api-client/docs/LabelControllerApi.md @@ -0,0 +1,392 @@ +# gooddata_api_client.LabelControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_all_entities_labels**](LabelControllerApi.md#get_all_entities_labels) | **GET** /api/v1/entities/workspaces/{workspaceId}/labels | Get all Labels +[**get_entity_labels**](LabelControllerApi.md#get_entity_labels) | **GET** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Get a Label +[**patch_entity_labels**](LabelControllerApi.md#patch_entity_labels) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Patch a Label (beta) +[**search_entities_labels**](LabelControllerApi.md#search_entities_labels) | **POST** /api/v1/entities/workspaces/{workspaceId}/labels/search | The search endpoint (beta) + + +# **get_all_entities_labels** +> JsonApiLabelOutList get_all_entities_labels(workspace_id) + +Get all Labels + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import label_controller_api +from gooddata_api_client.model.json_api_label_out_list import JsonApiLabelOutList +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = label_controller_api.LabelControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString;attribute.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "attribute", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get all Labels + api_response = api_instance.get_all_entities_labels(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LabelControllerApi->get_all_entities_labels: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Labels + api_response = api_instance.get_all_entities_labels(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LabelControllerApi->get_all_entities_labels: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiLabelOutList**](JsonApiLabelOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_labels** +> JsonApiLabelOutDocument get_entity_labels(workspace_id, object_id) + +Get a Label + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import label_controller_api +from gooddata_api_client.model.json_api_label_out_document import JsonApiLabelOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = label_controller_api.LabelControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;attribute.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "attribute", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a Label + api_response = api_instance.get_entity_labels(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LabelControllerApi->get_entity_labels: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Label + api_response = api_instance.get_entity_labels(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LabelControllerApi->get_entity_labels: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiLabelOutDocument**](JsonApiLabelOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **patch_entity_labels** +> JsonApiLabelOutDocument patch_entity_labels(workspace_id, object_id, json_api_label_patch_document) + +Patch a Label (beta) + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import label_controller_api +from gooddata_api_client.model.json_api_label_patch_document import JsonApiLabelPatchDocument +from gooddata_api_client.model.json_api_label_out_document import JsonApiLabelOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = label_controller_api.LabelControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_label_patch_document = JsonApiLabelPatchDocument( + data=JsonApiLabelPatch( + attributes=JsonApiAttributePatchAttributes( + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="label", + ), + ) # JsonApiLabelPatchDocument | + filter = "title==someString;description==someString;attribute.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "attribute", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Patch a Label (beta) + api_response = api_instance.patch_entity_labels(workspace_id, object_id, json_api_label_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LabelControllerApi->patch_entity_labels: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch a Label (beta) + api_response = api_instance.patch_entity_labels(workspace_id, object_id, json_api_label_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LabelControllerApi->patch_entity_labels: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_label_patch_document** | [**JsonApiLabelPatchDocument**](JsonApiLabelPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiLabelOutDocument**](JsonApiLabelOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **search_entities_labels** +> JsonApiLabelOutList search_entities_labels(workspace_id, entity_search_body) + +The search endpoint (beta) + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import label_controller_api +from gooddata_api_client.model.json_api_label_out_list import JsonApiLabelOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = label_controller_api.LabelControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + entity_search_body = EntitySearchBody( + filter="filter_example", + include=[ + "include_example", + ], + meta_include=[ + "meta_include_example", + ], + page=EntitySearchPage( + index=0, + size=100, + ), + sort=[ + EntitySearchSort( + direction="ASC", + _property="_property_example", + ), + ], + ) # EntitySearchBody | Search request body with filter, pagination, and sorting options + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_labels(workspace_id, entity_search_body) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LabelControllerApi->search_entities_labels: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_labels(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LabelControllerApi->search_entities_labels: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + +### Return type + +[**JsonApiLabelOutList**](JsonApiLabelOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/gooddata-api-client/docs/LabelsApi.md b/gooddata-api-client/docs/LabelsApi.md index 9f2a98ae2..99c819b1f 100644 --- a/gooddata-api-client/docs/LabelsApi.md +++ b/gooddata-api-client/docs/LabelsApi.md @@ -7,7 +7,7 @@ Method | HTTP request | Description [**get_all_entities_labels**](LabelsApi.md#get_all_entities_labels) | **GET** /api/v1/entities/workspaces/{workspaceId}/labels | Get all Labels [**get_entity_labels**](LabelsApi.md#get_entity_labels) | **GET** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Get a Label [**patch_entity_labels**](LabelsApi.md#patch_entity_labels) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Patch a Label (beta) -[**search_entities_labels**](LabelsApi.md#search_entities_labels) | **POST** /api/v1/entities/workspaces/{workspaceId}/labels/search | Search request for Label +[**search_entities_labels**](LabelsApi.md#search_entities_labels) | **POST** /api/v1/entities/workspaces/{workspaceId}/labels/search | The search endpoint (beta) # **get_all_entities_labels** @@ -294,7 +294,7 @@ No authorization required # **search_entities_labels** > JsonApiLabelOutList search_entities_labels(workspace_id, entity_search_body) -Search request for Label +The search endpoint (beta) ### Example @@ -342,7 +342,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Search request for Label + # The search endpoint (beta) api_response = api_instance.search_entities_labels(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -351,7 +351,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Search request for Label + # The search endpoint (beta) api_response = api_instance.search_entities_labels(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/LayoutApi.md b/gooddata-api-client/docs/LayoutApi.md index d8986cb7d..9ad5b7fdd 100644 --- a/gooddata-api-client/docs/LayoutApi.md +++ b/gooddata-api-client/docs/LayoutApi.md @@ -2911,6 +2911,7 @@ with gooddata_api_client.ApiClient() as api_client: settings=Settings( delimiter="U", export_info=True, + grand_totals_position="pinnedBottom", merge_headers=True, page_orientation="PORTRAIT", page_size="A4", @@ -4337,6 +4338,7 @@ with gooddata_api_client.ApiClient() as api_client: settings=Settings( delimiter="U", export_info=True, + grand_totals_position="pinnedBottom", merge_headers=True, page_orientation="PORTRAIT", page_size="A4", @@ -5652,6 +5654,7 @@ with gooddata_api_client.ApiClient() as api_client: settings=Settings( delimiter="U", export_info=True, + grand_totals_position="pinnedBottom", merge_headers=True, page_orientation="PORTRAIT", page_size="A4", diff --git a/gooddata-api-client/docs/ListLlmProviderModelsRequest.md b/gooddata-api-client/docs/ListLlmProviderModelsRequest.md new file mode 100644 index 000000000..8432da2c1 --- /dev/null +++ b/gooddata-api-client/docs/ListLlmProviderModelsRequest.md @@ -0,0 +1,12 @@ +# ListLlmProviderModelsRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**provider_config** | [**ListLlmProviderModelsRequestProviderConfig**](ListLlmProviderModelsRequestProviderConfig.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/TestLlmProviderDefinitionRequestProviderConfig.md b/gooddata-api-client/docs/ListLlmProviderModelsRequestProviderConfig.md similarity index 73% rename from gooddata-api-client/docs/TestLlmProviderDefinitionRequestProviderConfig.md rename to gooddata-api-client/docs/ListLlmProviderModelsRequestProviderConfig.md index d28dabb8d..7c86d8997 100644 --- a/gooddata-api-client/docs/TestLlmProviderDefinitionRequestProviderConfig.md +++ b/gooddata-api-client/docs/ListLlmProviderModelsRequestProviderConfig.md @@ -1,15 +1,15 @@ -# TestLlmProviderDefinitionRequestProviderConfig +# ListLlmProviderModelsRequestProviderConfig ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**base_url** | **str, none_type** | Custom base URL for OpenAI API. | [optional] if omitted the server will use the default value of "https://api.openai.com" +**base_url** | **str** | Custom base URL for OpenAI API. | [optional] if omitted the server will use the default value of "https://api.openai.com/v1" **organization** | **str, none_type** | OpenAI organization ID. | [optional] **auth** | [**OpenAiProviderAuth**](OpenAiProviderAuth.md) | | [optional] **region** | **str** | AWS region for Bedrock. | [optional] **type** | **str** | Provider type. | [optional] if omitted the server will use the default value of "OPENAI" -**endpoint** | **str** | Azure AI inference endpoint URL. | [optional] +**endpoint** | **str** | Azure OpenAI endpoint URL. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ListLlmProviderModelsResponse.md b/gooddata-api-client/docs/ListLlmProviderModelsResponse.md new file mode 100644 index 000000000..b3b81a65b --- /dev/null +++ b/gooddata-api-client/docs/ListLlmProviderModelsResponse.md @@ -0,0 +1,14 @@ +# ListLlmProviderModelsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **str** | Message about the listing result. | +**models** | [**[LlmModel]**](LlmModel.md) | Available models on the provider. | +**success** | **bool** | Whether the model listing succeeded. | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/LlmProviderConfig.md b/gooddata-api-client/docs/LlmProviderConfig.md index 9ce5198f8..c30bbc77a 100644 --- a/gooddata-api-client/docs/LlmProviderConfig.md +++ b/gooddata-api-client/docs/LlmProviderConfig.md @@ -1,16 +1,16 @@ # LlmProviderConfig -Provider configuration to test. +Provider configuration overrides. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**base_url** | **str, none_type** | Custom base URL for OpenAI API. | [optional] if omitted the server will use the default value of "https://api.openai.com" +**base_url** | **str** | Custom base URL for OpenAI API. | [optional] if omitted the server will use the default value of "https://api.openai.com/v1" **organization** | **str, none_type** | OpenAI organization ID. | [optional] **auth** | [**OpenAiProviderAuth**](OpenAiProviderAuth.md) | | [optional] **region** | **str** | AWS region for Bedrock. | [optional] **type** | **str** | Provider type. | [optional] if omitted the server will use the default value of "OPENAI" -**endpoint** | **str** | Azure AI inference endpoint URL. | [optional] +**endpoint** | **str** | Azure OpenAI endpoint URL. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/MetricControllerApi.md b/gooddata-api-client/docs/MetricControllerApi.md new file mode 100644 index 000000000..304f59e83 --- /dev/null +++ b/gooddata-api-client/docs/MetricControllerApi.md @@ -0,0 +1,688 @@ +# gooddata_api_client.MetricControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_metrics**](MetricControllerApi.md#create_entity_metrics) | **POST** /api/v1/entities/workspaces/{workspaceId}/metrics | Post Metrics +[**delete_entity_metrics**](MetricControllerApi.md#delete_entity_metrics) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Delete a Metric +[**get_all_entities_metrics**](MetricControllerApi.md#get_all_entities_metrics) | **GET** /api/v1/entities/workspaces/{workspaceId}/metrics | Get all Metrics +[**get_entity_metrics**](MetricControllerApi.md#get_entity_metrics) | **GET** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Get a Metric +[**patch_entity_metrics**](MetricControllerApi.md#patch_entity_metrics) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Patch a Metric +[**search_entities_metrics**](MetricControllerApi.md#search_entities_metrics) | **POST** /api/v1/entities/workspaces/{workspaceId}/metrics/search | The search endpoint (beta) +[**update_entity_metrics**](MetricControllerApi.md#update_entity_metrics) | **PUT** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Put a Metric + + +# **create_entity_metrics** +> JsonApiMetricOutDocument create_entity_metrics(workspace_id, json_api_metric_post_optional_id_document) + +Post Metrics + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import metric_controller_api +from gooddata_api_client.model.json_api_metric_post_optional_id_document import JsonApiMetricPostOptionalIdDocument +from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = metric_controller_api.MetricControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + json_api_metric_post_optional_id_document = JsonApiMetricPostOptionalIdDocument( + data=JsonApiMetricPostOptionalId( + attributes=JsonApiMetricInAttributes( + are_relations_valid=True, + content=JsonApiMetricInAttributesContent( + format="format_example", + maql="maql_example", + metric_type="UNSPECIFIED", + ), + description="description_example", + is_hidden=True, + is_hidden_from_kda=True, + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="metric", + ), + ) # JsonApiMetricPostOptionalIdDocument | + include = [ + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Metrics + api_response = api_instance.create_entity_metrics(workspace_id, json_api_metric_post_optional_id_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling MetricControllerApi->create_entity_metrics: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Metrics + api_response = api_instance.create_entity_metrics(workspace_id, json_api_metric_post_optional_id_document, include=include, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling MetricControllerApi->create_entity_metrics: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_metric_post_optional_id_document** | [**JsonApiMetricPostOptionalIdDocument**](JsonApiMetricPostOptionalIdDocument.md)| | + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiMetricOutDocument**](JsonApiMetricOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_entity_metrics** +> delete_entity_metrics(workspace_id, object_id) + +Delete a Metric + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import metric_controller_api +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = metric_controller_api.MetricControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Delete a Metric + api_instance.delete_entity_metrics(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling MetricControllerApi->delete_entity_metrics: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete a Metric + api_instance.delete_entity_metrics(workspace_id, object_id, filter=filter) + except gooddata_api_client.ApiException as e: + print("Exception when calling MetricControllerApi->delete_entity_metrics: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successfully deleted | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_entities_metrics** +> JsonApiMetricOutList get_all_entities_metrics(workspace_id) + +Get all Metrics + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import metric_controller_api +from gooddata_api_client.model.json_api_metric_out_list import JsonApiMetricOutList +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = metric_controller_api.MetricControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get all Metrics + api_response = api_instance.get_all_entities_metrics(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling MetricControllerApi->get_all_entities_metrics: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Metrics + api_response = api_instance.get_all_entities_metrics(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling MetricControllerApi->get_all_entities_metrics: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiMetricOutList**](JsonApiMetricOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_metrics** +> JsonApiMetricOutDocument get_entity_metrics(workspace_id, object_id) + +Get a Metric + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import metric_controller_api +from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = metric_controller_api.MetricControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a Metric + api_response = api_instance.get_entity_metrics(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling MetricControllerApi->get_entity_metrics: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Metric + api_response = api_instance.get_entity_metrics(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling MetricControllerApi->get_entity_metrics: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiMetricOutDocument**](JsonApiMetricOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **patch_entity_metrics** +> JsonApiMetricOutDocument patch_entity_metrics(workspace_id, object_id, json_api_metric_patch_document) + +Patch a Metric + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import metric_controller_api +from gooddata_api_client.model.json_api_metric_patch_document import JsonApiMetricPatchDocument +from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = metric_controller_api.MetricControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_metric_patch_document = JsonApiMetricPatchDocument( + data=JsonApiMetricPatch( + attributes=JsonApiMetricPatchAttributes( + are_relations_valid=True, + content=JsonApiMetricInAttributesContent( + format="format_example", + maql="maql_example", + metric_type="UNSPECIFIED", + ), + description="description_example", + is_hidden=True, + is_hidden_from_kda=True, + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="metric", + ), + ) # JsonApiMetricPatchDocument | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Patch a Metric + api_response = api_instance.patch_entity_metrics(workspace_id, object_id, json_api_metric_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling MetricControllerApi->patch_entity_metrics: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch a Metric + api_response = api_instance.patch_entity_metrics(workspace_id, object_id, json_api_metric_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling MetricControllerApi->patch_entity_metrics: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_metric_patch_document** | [**JsonApiMetricPatchDocument**](JsonApiMetricPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiMetricOutDocument**](JsonApiMetricOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **search_entities_metrics** +> JsonApiMetricOutList search_entities_metrics(workspace_id, entity_search_body) + +The search endpoint (beta) + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import metric_controller_api +from gooddata_api_client.model.json_api_metric_out_list import JsonApiMetricOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = metric_controller_api.MetricControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + entity_search_body = EntitySearchBody( + filter="filter_example", + include=[ + "include_example", + ], + meta_include=[ + "meta_include_example", + ], + page=EntitySearchPage( + index=0, + size=100, + ), + sort=[ + EntitySearchSort( + direction="ASC", + _property="_property_example", + ), + ], + ) # EntitySearchBody | Search request body with filter, pagination, and sorting options + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_metrics(workspace_id, entity_search_body) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling MetricControllerApi->search_entities_metrics: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_metrics(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling MetricControllerApi->search_entities_metrics: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + +### Return type + +[**JsonApiMetricOutList**](JsonApiMetricOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_entity_metrics** +> JsonApiMetricOutDocument update_entity_metrics(workspace_id, object_id, json_api_metric_in_document) + +Put a Metric + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import metric_controller_api +from gooddata_api_client.model.json_api_metric_in_document import JsonApiMetricInDocument +from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = metric_controller_api.MetricControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_metric_in_document = JsonApiMetricInDocument( + data=JsonApiMetricIn( + attributes=JsonApiMetricInAttributes( + are_relations_valid=True, + content=JsonApiMetricInAttributesContent( + format="format_example", + maql="maql_example", + metric_type="UNSPECIFIED", + ), + description="description_example", + is_hidden=True, + is_hidden_from_kda=True, + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="metric", + ), + ) # JsonApiMetricInDocument | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Put a Metric + api_response = api_instance.update_entity_metrics(workspace_id, object_id, json_api_metric_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling MetricControllerApi->update_entity_metrics: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put a Metric + api_response = api_instance.update_entity_metrics(workspace_id, object_id, json_api_metric_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling MetricControllerApi->update_entity_metrics: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_metric_in_document** | [**JsonApiMetricInDocument**](JsonApiMetricInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiMetricOutDocument**](JsonApiMetricOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/gooddata-api-client/docs/MetricsApi.md b/gooddata-api-client/docs/MetricsApi.md index 18eddb5b3..b69cbe77c 100644 --- a/gooddata-api-client/docs/MetricsApi.md +++ b/gooddata-api-client/docs/MetricsApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description [**get_all_entities_metrics**](MetricsApi.md#get_all_entities_metrics) | **GET** /api/v1/entities/workspaces/{workspaceId}/metrics | Get all Metrics [**get_entity_metrics**](MetricsApi.md#get_entity_metrics) | **GET** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Get a Metric [**patch_entity_metrics**](MetricsApi.md#patch_entity_metrics) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Patch a Metric -[**search_entities_metrics**](MetricsApi.md#search_entities_metrics) | **POST** /api/v1/entities/workspaces/{workspaceId}/metrics/search | Search request for Metric +[**search_entities_metrics**](MetricsApi.md#search_entities_metrics) | **POST** /api/v1/entities/workspaces/{workspaceId}/metrics/search | The search endpoint (beta) [**update_entity_metrics**](MetricsApi.md#update_entity_metrics) | **PUT** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Put a Metric @@ -485,7 +485,7 @@ No authorization required # **search_entities_metrics** > JsonApiMetricOutList search_entities_metrics(workspace_id, entity_search_body) -Search request for Metric +The search endpoint (beta) ### Example @@ -533,7 +533,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Search request for Metric + # The search endpoint (beta) api_response = api_instance.search_entities_metrics(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -542,7 +542,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Search request for Metric + # The search endpoint (beta) api_response = api_instance.search_entities_metrics(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/ObjectReference.md b/gooddata-api-client/docs/ObjectReference.md new file mode 100644 index 000000000..a559f3bb5 --- /dev/null +++ b/gooddata-api-client/docs/ObjectReference.md @@ -0,0 +1,13 @@ +# ObjectReference + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Object identifier (e.g. widget ID, metric ID). | +**type** | **str** | Type of the referenced object. | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/ObjectReferenceGroup.md b/gooddata-api-client/docs/ObjectReferenceGroup.md new file mode 100644 index 000000000..fdabb612f --- /dev/null +++ b/gooddata-api-client/docs/ObjectReferenceGroup.md @@ -0,0 +1,13 @@ +# ObjectReferenceGroup + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**objects** | [**[ObjectReference]**](ObjectReference.md) | Objects the user explicitly referenced within this context. | +**context** | [**ObjectReference**](ObjectReference.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/OpenAIProviderConfig.md b/gooddata-api-client/docs/OpenAIProviderConfig.md index aa6fa09ae..3afcb5513 100644 --- a/gooddata-api-client/docs/OpenAIProviderConfig.md +++ b/gooddata-api-client/docs/OpenAIProviderConfig.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **auth** | [**OpenAiProviderAuth**](OpenAiProviderAuth.md) | | **type** | **str** | Provider type. | defaults to "OPENAI" -**base_url** | **str, none_type** | Custom base URL for OpenAI API. | [optional] if omitted the server will use the default value of "https://api.openai.com" +**base_url** | **str** | Custom base URL for OpenAI API. | [optional] if omitted the server will use the default value of "https://api.openai.com/v1" **organization** | **str, none_type** | OpenAI organization ID. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md b/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md index 48d280bbe..8d422c77a 100644 --- a/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md @@ -772,6 +772,7 @@ with gooddata_api_client.ApiClient() as api_client: settings=Settings( delimiter="U", export_info=True, + grand_totals_position="pinnedBottom", merge_headers=True, page_orientation="PORTRAIT", page_size="A4", diff --git a/gooddata-api-client/docs/OrganizationControllerApi.md b/gooddata-api-client/docs/OrganizationEntityControllerApi.md similarity index 50% rename from gooddata-api-client/docs/OrganizationControllerApi.md rename to gooddata-api-client/docs/OrganizationEntityControllerApi.md index 128bebd7d..412aab308 100644 --- a/gooddata-api-client/docs/OrganizationControllerApi.md +++ b/gooddata-api-client/docs/OrganizationEntityControllerApi.md @@ -1,93 +1,14 @@ -# gooddata_api_client.OrganizationControllerApi +# gooddata_api_client.OrganizationEntityControllerApi All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get_entity_cookie_security_configurations**](OrganizationControllerApi.md#get_entity_cookie_security_configurations) | **GET** /api/v1/entities/admin/cookieSecurityConfigurations/{id} | Get CookieSecurityConfiguration -[**get_entity_organizations**](OrganizationControllerApi.md#get_entity_organizations) | **GET** /api/v1/entities/admin/organizations/{id} | Get Organizations -[**patch_entity_cookie_security_configurations**](OrganizationControllerApi.md#patch_entity_cookie_security_configurations) | **PATCH** /api/v1/entities/admin/cookieSecurityConfigurations/{id} | Patch CookieSecurityConfiguration -[**patch_entity_organizations**](OrganizationControllerApi.md#patch_entity_organizations) | **PATCH** /api/v1/entities/admin/organizations/{id} | Patch Organization -[**update_entity_cookie_security_configurations**](OrganizationControllerApi.md#update_entity_cookie_security_configurations) | **PUT** /api/v1/entities/admin/cookieSecurityConfigurations/{id} | Put CookieSecurityConfiguration -[**update_entity_organizations**](OrganizationControllerApi.md#update_entity_organizations) | **PUT** /api/v1/entities/admin/organizations/{id} | Put Organization +[**get_entity_organizations**](OrganizationEntityControllerApi.md#get_entity_organizations) | **GET** /api/v1/entities/admin/organizations/{id} | Get Organizations +[**patch_entity_organizations**](OrganizationEntityControllerApi.md#patch_entity_organizations) | **PATCH** /api/v1/entities/admin/organizations/{id} | Patch Organization +[**update_entity_organizations**](OrganizationEntityControllerApi.md#update_entity_organizations) | **PUT** /api/v1/entities/admin/organizations/{id} | Put Organization -# **get_entity_cookie_security_configurations** -> JsonApiCookieSecurityConfigurationOutDocument get_entity_cookie_security_configurations(id) - -Get CookieSecurityConfiguration - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import organization_controller_api -from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = organization_controller_api.OrganizationControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "lastRotation==InstantValue;rotationInterval==DurationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Get CookieSecurityConfiguration - api_response = api_instance.get_entity_cookie_security_configurations(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationControllerApi->get_entity_cookie_security_configurations: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get CookieSecurityConfiguration - api_response = api_instance.get_entity_cookie_security_configurations(id, filter=filter) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationControllerApi->get_entity_cookie_security_configurations: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -[**JsonApiCookieSecurityConfigurationOutDocument**](JsonApiCookieSecurityConfigurationOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - # **get_entity_organizations** > JsonApiOrganizationOutDocument get_entity_organizations(id) @@ -99,7 +20,7 @@ Get Organizations ```python import time import gooddata_api_client -from gooddata_api_client.api import organization_controller_api +from gooddata_api_client.api import organization_entity_controller_api from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost @@ -112,7 +33,7 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class - api_instance = organization_controller_api.OrganizationControllerApi(api_client) + api_instance = organization_entity_controller_api.OrganizationEntityControllerApi(api_client) id = "/6bUUGjjNSwg0_bs" # str | filter = "name==someString;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ @@ -128,7 +49,7 @@ with gooddata_api_client.ApiClient() as api_client: api_response = api_instance.get_entity_organizations(id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationControllerApi->get_entity_organizations: %s\n" % e) + print("Exception when calling OrganizationEntityControllerApi->get_entity_organizations: %s\n" % e) # example passing only required values which don't have defaults set # and optional values @@ -137,7 +58,7 @@ with gooddata_api_client.ApiClient() as api_client: api_response = api_instance.get_entity_organizations(id, filter=filter, include=include, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationControllerApi->get_entity_organizations: %s\n" % e) + print("Exception when calling OrganizationEntityControllerApi->get_entity_organizations: %s\n" % e) ``` @@ -164,94 +85,6 @@ No authorization required - **Accept**: application/json, application/vnd.gooddata.api+json -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **patch_entity_cookie_security_configurations** -> JsonApiCookieSecurityConfigurationOutDocument patch_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_patch_document) - -Patch CookieSecurityConfiguration - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import organization_controller_api -from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument -from gooddata_api_client.model.json_api_cookie_security_configuration_patch_document import JsonApiCookieSecurityConfigurationPatchDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = organization_controller_api.OrganizationControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_cookie_security_configuration_patch_document = JsonApiCookieSecurityConfigurationPatchDocument( - data=JsonApiCookieSecurityConfigurationPatch( - attributes=JsonApiCookieSecurityConfigurationInAttributes( - last_rotation=dateutil_parser('1970-01-01T00:00:00.00Z'), - rotation_interval="P30D", - ), - id="id1", - type="cookieSecurityConfiguration", - ), - ) # JsonApiCookieSecurityConfigurationPatchDocument | - filter = "lastRotation==InstantValue;rotationInterval==DurationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch CookieSecurityConfiguration - api_response = api_instance.patch_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationControllerApi->patch_entity_cookie_security_configurations: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Patch CookieSecurityConfiguration - api_response = api_instance.patch_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_patch_document, filter=filter) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationControllerApi->patch_entity_cookie_security_configurations: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_cookie_security_configuration_patch_document** | [**JsonApiCookieSecurityConfigurationPatchDocument**](JsonApiCookieSecurityConfigurationPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -[**JsonApiCookieSecurityConfigurationOutDocument**](JsonApiCookieSecurityConfigurationOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - ### HTTP response details | Status code | Description | Response headers | @@ -271,7 +104,7 @@ Patch Organization ```python import time import gooddata_api_client -from gooddata_api_client.api import organization_controller_api +from gooddata_api_client.api import organization_entity_controller_api from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument from gooddata_api_client.model.json_api_organization_patch_document import JsonApiOrganizationPatchDocument from pprint import pprint @@ -285,7 +118,7 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class - api_instance = organization_controller_api.OrganizationControllerApi(api_client) + api_instance = organization_entity_controller_api.OrganizationEntityControllerApi(api_client) id = "/6bUUGjjNSwg0_bs" # str | json_api_organization_patch_document = JsonApiOrganizationPatchDocument( data=JsonApiOrganizationPatch( @@ -320,7 +153,7 @@ with gooddata_api_client.ApiClient() as api_client: api_response = api_instance.patch_entity_organizations(id, json_api_organization_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationControllerApi->patch_entity_organizations: %s\n" % e) + print("Exception when calling OrganizationEntityControllerApi->patch_entity_organizations: %s\n" % e) # example passing only required values which don't have defaults set # and optional values @@ -329,7 +162,7 @@ with gooddata_api_client.ApiClient() as api_client: api_response = api_instance.patch_entity_organizations(id, json_api_organization_patch_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationControllerApi->patch_entity_organizations: %s\n" % e) + print("Exception when calling OrganizationEntityControllerApi->patch_entity_organizations: %s\n" % e) ``` @@ -356,94 +189,6 @@ No authorization required - **Accept**: application/json, application/vnd.gooddata.api+json -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_entity_cookie_security_configurations** -> JsonApiCookieSecurityConfigurationOutDocument update_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_in_document) - -Put CookieSecurityConfiguration - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import organization_controller_api -from gooddata_api_client.model.json_api_cookie_security_configuration_in_document import JsonApiCookieSecurityConfigurationInDocument -from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = organization_controller_api.OrganizationControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_cookie_security_configuration_in_document = JsonApiCookieSecurityConfigurationInDocument( - data=JsonApiCookieSecurityConfigurationIn( - attributes=JsonApiCookieSecurityConfigurationInAttributes( - last_rotation=dateutil_parser('1970-01-01T00:00:00.00Z'), - rotation_interval="P30D", - ), - id="id1", - type="cookieSecurityConfiguration", - ), - ) # JsonApiCookieSecurityConfigurationInDocument | - filter = "lastRotation==InstantValue;rotationInterval==DurationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put CookieSecurityConfiguration - api_response = api_instance.update_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationControllerApi->update_entity_cookie_security_configurations: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Put CookieSecurityConfiguration - api_response = api_instance.update_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_in_document, filter=filter) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationControllerApi->update_entity_cookie_security_configurations: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_cookie_security_configuration_in_document** | [**JsonApiCookieSecurityConfigurationInDocument**](JsonApiCookieSecurityConfigurationInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -[**JsonApiCookieSecurityConfigurationOutDocument**](JsonApiCookieSecurityConfigurationOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - ### HTTP response details | Status code | Description | Response headers | @@ -463,7 +208,7 @@ Put Organization ```python import time import gooddata_api_client -from gooddata_api_client.api import organization_controller_api +from gooddata_api_client.api import organization_entity_controller_api from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument from gooddata_api_client.model.json_api_organization_in_document import JsonApiOrganizationInDocument from pprint import pprint @@ -477,7 +222,7 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class - api_instance = organization_controller_api.OrganizationControllerApi(api_client) + api_instance = organization_entity_controller_api.OrganizationEntityControllerApi(api_client) id = "/6bUUGjjNSwg0_bs" # str | json_api_organization_in_document = JsonApiOrganizationInDocument( data=JsonApiOrganizationIn( @@ -512,7 +257,7 @@ with gooddata_api_client.ApiClient() as api_client: api_response = api_instance.update_entity_organizations(id, json_api_organization_in_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationControllerApi->update_entity_organizations: %s\n" % e) + print("Exception when calling OrganizationEntityControllerApi->update_entity_organizations: %s\n" % e) # example passing only required values which don't have defaults set # and optional values @@ -521,7 +266,7 @@ with gooddata_api_client.ApiClient() as api_client: api_response = api_instance.update_entity_organizations(id, json_api_organization_in_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationControllerApi->update_entity_organizations: %s\n" % e) + print("Exception when calling OrganizationEntityControllerApi->update_entity_organizations: %s\n" % e) ``` diff --git a/gooddata-api-client/docs/OrganizationModelControllerApi.md b/gooddata-api-client/docs/OrganizationModelControllerApi.md index ef07ba041..55b66f9d8 100644 --- a/gooddata-api-client/docs/OrganizationModelControllerApi.md +++ b/gooddata-api-client/docs/OrganizationModelControllerApi.md @@ -6,11 +6,8 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**create_entity_color_palettes**](OrganizationModelControllerApi.md#create_entity_color_palettes) | **POST** /api/v1/entities/colorPalettes | Post Color Pallettes [**create_entity_csp_directives**](OrganizationModelControllerApi.md#create_entity_csp_directives) | **POST** /api/v1/entities/cspDirectives | Post CSP Directives -[**create_entity_custom_geo_collections**](OrganizationModelControllerApi.md#create_entity_custom_geo_collections) | **POST** /api/v1/entities/customGeoCollections | -[**create_entity_data_sources**](OrganizationModelControllerApi.md#create_entity_data_sources) | **POST** /api/v1/entities/dataSources | Post Data Sources [**create_entity_export_templates**](OrganizationModelControllerApi.md#create_entity_export_templates) | **POST** /api/v1/entities/exportTemplates | Post Export Template entities [**create_entity_identity_providers**](OrganizationModelControllerApi.md#create_entity_identity_providers) | **POST** /api/v1/entities/identityProviders | Post Identity Providers -[**create_entity_jwks**](OrganizationModelControllerApi.md#create_entity_jwks) | **POST** /api/v1/entities/jwks | Post Jwks [**create_entity_llm_endpoints**](OrganizationModelControllerApi.md#create_entity_llm_endpoints) | **POST** /api/v1/entities/llmEndpoints | Post LLM endpoint entities [**create_entity_llm_providers**](OrganizationModelControllerApi.md#create_entity_llm_providers) | **POST** /api/v1/entities/llmProviders | Post LLM Provider entities [**create_entity_notification_channels**](OrganizationModelControllerApi.md#create_entity_notification_channels) | **POST** /api/v1/entities/notificationChannels | Post Notification Channel entities @@ -21,11 +18,8 @@ Method | HTTP request | Description [**create_entity_workspaces**](OrganizationModelControllerApi.md#create_entity_workspaces) | **POST** /api/v1/entities/workspaces | Post Workspace entities [**delete_entity_color_palettes**](OrganizationModelControllerApi.md#delete_entity_color_palettes) | **DELETE** /api/v1/entities/colorPalettes/{id} | Delete a Color Pallette [**delete_entity_csp_directives**](OrganizationModelControllerApi.md#delete_entity_csp_directives) | **DELETE** /api/v1/entities/cspDirectives/{id} | Delete CSP Directives -[**delete_entity_custom_geo_collections**](OrganizationModelControllerApi.md#delete_entity_custom_geo_collections) | **DELETE** /api/v1/entities/customGeoCollections/{id} | -[**delete_entity_data_sources**](OrganizationModelControllerApi.md#delete_entity_data_sources) | **DELETE** /api/v1/entities/dataSources/{id} | Delete Data Source entity [**delete_entity_export_templates**](OrganizationModelControllerApi.md#delete_entity_export_templates) | **DELETE** /api/v1/entities/exportTemplates/{id} | Delete Export Template entity [**delete_entity_identity_providers**](OrganizationModelControllerApi.md#delete_entity_identity_providers) | **DELETE** /api/v1/entities/identityProviders/{id} | Delete Identity Provider -[**delete_entity_jwks**](OrganizationModelControllerApi.md#delete_entity_jwks) | **DELETE** /api/v1/entities/jwks/{id} | Delete Jwk [**delete_entity_llm_endpoints**](OrganizationModelControllerApi.md#delete_entity_llm_endpoints) | **DELETE** /api/v1/entities/llmEndpoints/{id} | [**delete_entity_llm_providers**](OrganizationModelControllerApi.md#delete_entity_llm_providers) | **DELETE** /api/v1/entities/llmProviders/{id} | Delete LLM Provider entity [**delete_entity_notification_channels**](OrganizationModelControllerApi.md#delete_entity_notification_channels) | **DELETE** /api/v1/entities/notificationChannels/{id} | Delete Notification Channel entity @@ -36,13 +30,10 @@ Method | HTTP request | Description [**delete_entity_workspaces**](OrganizationModelControllerApi.md#delete_entity_workspaces) | **DELETE** /api/v1/entities/workspaces/{id} | Delete Workspace entity [**get_all_entities_color_palettes**](OrganizationModelControllerApi.md#get_all_entities_color_palettes) | **GET** /api/v1/entities/colorPalettes | Get all Color Pallettes [**get_all_entities_csp_directives**](OrganizationModelControllerApi.md#get_all_entities_csp_directives) | **GET** /api/v1/entities/cspDirectives | Get CSP Directives -[**get_all_entities_custom_geo_collections**](OrganizationModelControllerApi.md#get_all_entities_custom_geo_collections) | **GET** /api/v1/entities/customGeoCollections | [**get_all_entities_data_source_identifiers**](OrganizationModelControllerApi.md#get_all_entities_data_source_identifiers) | **GET** /api/v1/entities/dataSourceIdentifiers | Get all Data Source Identifiers -[**get_all_entities_data_sources**](OrganizationModelControllerApi.md#get_all_entities_data_sources) | **GET** /api/v1/entities/dataSources | Get Data Source entities [**get_all_entities_entitlements**](OrganizationModelControllerApi.md#get_all_entities_entitlements) | **GET** /api/v1/entities/entitlements | Get Entitlements [**get_all_entities_export_templates**](OrganizationModelControllerApi.md#get_all_entities_export_templates) | **GET** /api/v1/entities/exportTemplates | GET all Export Template entities [**get_all_entities_identity_providers**](OrganizationModelControllerApi.md#get_all_entities_identity_providers) | **GET** /api/v1/entities/identityProviders | Get all Identity Providers -[**get_all_entities_jwks**](OrganizationModelControllerApi.md#get_all_entities_jwks) | **GET** /api/v1/entities/jwks | Get all Jwks [**get_all_entities_llm_endpoints**](OrganizationModelControllerApi.md#get_all_entities_llm_endpoints) | **GET** /api/v1/entities/llmEndpoints | Get all LLM endpoint entities [**get_all_entities_llm_providers**](OrganizationModelControllerApi.md#get_all_entities_llm_providers) | **GET** /api/v1/entities/llmProviders | Get all LLM Provider entities [**get_all_entities_notification_channel_identifiers**](OrganizationModelControllerApi.md#get_all_entities_notification_channel_identifiers) | **GET** /api/v1/entities/notificationChannelIdentifiers | @@ -55,13 +46,10 @@ Method | HTTP request | Description [**get_all_entities_workspaces**](OrganizationModelControllerApi.md#get_all_entities_workspaces) | **GET** /api/v1/entities/workspaces | Get Workspace entities [**get_entity_color_palettes**](OrganizationModelControllerApi.md#get_entity_color_palettes) | **GET** /api/v1/entities/colorPalettes/{id} | Get Color Pallette [**get_entity_csp_directives**](OrganizationModelControllerApi.md#get_entity_csp_directives) | **GET** /api/v1/entities/cspDirectives/{id} | Get CSP Directives -[**get_entity_custom_geo_collections**](OrganizationModelControllerApi.md#get_entity_custom_geo_collections) | **GET** /api/v1/entities/customGeoCollections/{id} | [**get_entity_data_source_identifiers**](OrganizationModelControllerApi.md#get_entity_data_source_identifiers) | **GET** /api/v1/entities/dataSourceIdentifiers/{id} | Get Data Source Identifier -[**get_entity_data_sources**](OrganizationModelControllerApi.md#get_entity_data_sources) | **GET** /api/v1/entities/dataSources/{id} | Get Data Source entity [**get_entity_entitlements**](OrganizationModelControllerApi.md#get_entity_entitlements) | **GET** /api/v1/entities/entitlements/{id} | Get Entitlement [**get_entity_export_templates**](OrganizationModelControllerApi.md#get_entity_export_templates) | **GET** /api/v1/entities/exportTemplates/{id} | GET Export Template entity [**get_entity_identity_providers**](OrganizationModelControllerApi.md#get_entity_identity_providers) | **GET** /api/v1/entities/identityProviders/{id} | Get Identity Provider -[**get_entity_jwks**](OrganizationModelControllerApi.md#get_entity_jwks) | **GET** /api/v1/entities/jwks/{id} | Get Jwk [**get_entity_llm_endpoints**](OrganizationModelControllerApi.md#get_entity_llm_endpoints) | **GET** /api/v1/entities/llmEndpoints/{id} | Get LLM endpoint entity [**get_entity_llm_providers**](OrganizationModelControllerApi.md#get_entity_llm_providers) | **GET** /api/v1/entities/llmProviders/{id} | Get LLM Provider entity [**get_entity_notification_channel_identifiers**](OrganizationModelControllerApi.md#get_entity_notification_channel_identifiers) | **GET** /api/v1/entities/notificationChannelIdentifiers/{id} | @@ -74,11 +62,8 @@ Method | HTTP request | Description [**get_entity_workspaces**](OrganizationModelControllerApi.md#get_entity_workspaces) | **GET** /api/v1/entities/workspaces/{id} | Get Workspace entity [**patch_entity_color_palettes**](OrganizationModelControllerApi.md#patch_entity_color_palettes) | **PATCH** /api/v1/entities/colorPalettes/{id} | Patch Color Pallette [**patch_entity_csp_directives**](OrganizationModelControllerApi.md#patch_entity_csp_directives) | **PATCH** /api/v1/entities/cspDirectives/{id} | Patch CSP Directives -[**patch_entity_custom_geo_collections**](OrganizationModelControllerApi.md#patch_entity_custom_geo_collections) | **PATCH** /api/v1/entities/customGeoCollections/{id} | -[**patch_entity_data_sources**](OrganizationModelControllerApi.md#patch_entity_data_sources) | **PATCH** /api/v1/entities/dataSources/{id} | Patch Data Source entity [**patch_entity_export_templates**](OrganizationModelControllerApi.md#patch_entity_export_templates) | **PATCH** /api/v1/entities/exportTemplates/{id} | Patch Export Template entity [**patch_entity_identity_providers**](OrganizationModelControllerApi.md#patch_entity_identity_providers) | **PATCH** /api/v1/entities/identityProviders/{id} | Patch Identity Provider -[**patch_entity_jwks**](OrganizationModelControllerApi.md#patch_entity_jwks) | **PATCH** /api/v1/entities/jwks/{id} | Patch Jwk [**patch_entity_llm_endpoints**](OrganizationModelControllerApi.md#patch_entity_llm_endpoints) | **PATCH** /api/v1/entities/llmEndpoints/{id} | Patch LLM endpoint entity [**patch_entity_llm_providers**](OrganizationModelControllerApi.md#patch_entity_llm_providers) | **PATCH** /api/v1/entities/llmProviders/{id} | Patch LLM Provider entity [**patch_entity_notification_channels**](OrganizationModelControllerApi.md#patch_entity_notification_channels) | **PATCH** /api/v1/entities/notificationChannels/{id} | Patch Notification Channel entity @@ -89,11 +74,8 @@ Method | HTTP request | Description [**patch_entity_workspaces**](OrganizationModelControllerApi.md#patch_entity_workspaces) | **PATCH** /api/v1/entities/workspaces/{id} | Patch Workspace entity [**update_entity_color_palettes**](OrganizationModelControllerApi.md#update_entity_color_palettes) | **PUT** /api/v1/entities/colorPalettes/{id} | Put Color Pallette [**update_entity_csp_directives**](OrganizationModelControllerApi.md#update_entity_csp_directives) | **PUT** /api/v1/entities/cspDirectives/{id} | Put CSP Directives -[**update_entity_custom_geo_collections**](OrganizationModelControllerApi.md#update_entity_custom_geo_collections) | **PUT** /api/v1/entities/customGeoCollections/{id} | -[**update_entity_data_sources**](OrganizationModelControllerApi.md#update_entity_data_sources) | **PUT** /api/v1/entities/dataSources/{id} | Put Data Source entity [**update_entity_export_templates**](OrganizationModelControllerApi.md#update_entity_export_templates) | **PUT** /api/v1/entities/exportTemplates/{id} | PUT Export Template entity [**update_entity_identity_providers**](OrganizationModelControllerApi.md#update_entity_identity_providers) | **PUT** /api/v1/entities/identityProviders/{id} | Put Identity Provider -[**update_entity_jwks**](OrganizationModelControllerApi.md#update_entity_jwks) | **PUT** /api/v1/entities/jwks/{id} | Put Jwk [**update_entity_llm_endpoints**](OrganizationModelControllerApi.md#update_entity_llm_endpoints) | **PUT** /api/v1/entities/llmEndpoints/{id} | PUT LLM endpoint entity [**update_entity_llm_providers**](OrganizationModelControllerApi.md#update_entity_llm_providers) | **PUT** /api/v1/entities/llmProviders/{id} | PUT LLM Provider entity [**update_entity_notification_channels**](OrganizationModelControllerApi.md#update_entity_notification_channels) | **PUT** /api/v1/entities/notificationChannels/{id} | Put Notification Channel entity @@ -249,187 +231,6 @@ No authorization required - **Accept**: application/json, application/vnd.gooddata.api+json -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_entity_custom_geo_collections** -> JsonApiCustomGeoCollectionOutDocument create_entity_custom_geo_collections(json_api_custom_geo_collection_in_document) - - - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_custom_geo_collection_out_document import JsonApiCustomGeoCollectionOutDocument -from gooddata_api_client.model.json_api_custom_geo_collection_in_document import JsonApiCustomGeoCollectionInDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - json_api_custom_geo_collection_in_document = JsonApiCustomGeoCollectionInDocument( - data=JsonApiCustomGeoCollectionIn( - attributes=JsonApiCustomGeoCollectionInAttributes( - description="description_example", - name="name_example", - ), - id="id1", - type="customGeoCollection", - ), - ) # JsonApiCustomGeoCollectionInDocument | - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.create_entity_custom_geo_collections(json_api_custom_geo_collection_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->create_entity_custom_geo_collections: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **json_api_custom_geo_collection_in_document** | [**JsonApiCustomGeoCollectionInDocument**](JsonApiCustomGeoCollectionInDocument.md)| | - -### Return type - -[**JsonApiCustomGeoCollectionOutDocument**](JsonApiCustomGeoCollectionOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_entity_data_sources** -> JsonApiDataSourceOutDocument create_entity_data_sources(json_api_data_source_in_document) - -Post Data Sources - -Data Source - represents data source for the workspace - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_data_source_in_document import JsonApiDataSourceInDocument -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - json_api_data_source_in_document = JsonApiDataSourceInDocument( - data=JsonApiDataSourceIn( - attributes=JsonApiDataSourceInAttributes( - alternative_data_source_id="pg_local_docker-demo2", - cache_strategy="ALWAYS", - client_id="client_id_example", - client_secret="client_secret_example", - name="name_example", - parameters=[ - JsonApiDataSourceInAttributesParametersInner( - name="name_example", - value="value_example", - ), - ], - password="password_example", - private_key="private_key_example", - private_key_passphrase="private_key_passphrase_example", - schema="schema_example", - token="token_example", - type="POSTGRESQL", - url="url_example", - username="username_example", - ), - id="id1", - type="dataSource", - ), - ) # JsonApiDataSourceInDocument | - meta_include = [ - "metaInclude=permissions,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Data Sources - api_response = api_instance.create_entity_data_sources(json_api_data_source_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->create_entity_data_sources: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Post Data Sources - api_response = api_instance.create_entity_data_sources(json_api_data_source_in_document, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->create_entity_data_sources: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **json_api_data_source_in_document** | [**JsonApiDataSourceInDocument**](JsonApiDataSourceInDocument.md)| | - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiDataSourceOutDocument**](JsonApiDataSourceOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - ### HTTP response details | Status code | Description | Response headers | @@ -661,82 +462,6 @@ No authorization required - **Accept**: application/json, application/vnd.gooddata.api+json -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_entity_jwks** -> JsonApiJwkOutDocument create_entity_jwks(json_api_jwk_in_document) - -Post Jwks - -Creates JSON web key - used to verify JSON web tokens (Jwts) - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_jwk_in_document import JsonApiJwkInDocument -from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - json_api_jwk_in_document = JsonApiJwkInDocument( - data=JsonApiJwkIn( - attributes=JsonApiJwkInAttributes( - content=JsonApiJwkInAttributesContent(), - ), - id="id1", - type="jwk", - ), - ) # JsonApiJwkInDocument | - - # example passing only required values which don't have defaults set - try: - # Post Jwks - api_response = api_instance.create_entity_jwks(json_api_jwk_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->create_entity_jwks: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **json_api_jwk_in_document** | [**JsonApiJwkInDocument**](JsonApiJwkInDocument.md)| | - -### Return type - -[**JsonApiJwkOutDocument**](JsonApiJwkOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - ### HTTP response details | Status code | Description | Response headers | @@ -1600,10 +1325,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_custom_geo_collections** -> delete_entity_custom_geo_collections(id) - +# **delete_entity_export_templates** +> delete_entity_export_templates(id) +Delete Export Template entity ### Example @@ -1625,20 +1350,22 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) # example passing only required values which don't have defaults set try: - api_instance.delete_entity_custom_geo_collections(id) + # Delete Export Template entity + api_instance.delete_entity_export_templates(id) except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->delete_entity_custom_geo_collections: %s\n" % e) + print("Exception when calling OrganizationModelControllerApi->delete_entity_export_templates: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - api_instance.delete_entity_custom_geo_collections(id, filter=filter) + # Delete Export Template entity + api_instance.delete_entity_export_templates(id, filter=filter) except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->delete_entity_custom_geo_collections: %s\n" % e) + print("Exception when calling OrganizationModelControllerApi->delete_entity_export_templates: %s\n" % e) ``` @@ -1671,12 +1398,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_data_sources** -> delete_entity_data_sources(id) - -Delete Data Source entity +# **delete_entity_identity_providers** +> delete_entity_identity_providers(id) -Data Source - represents data source for the workspace +Delete Identity Provider ### Example @@ -1698,22 +1423,22 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;type==DatabaseTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "identifiers==v1,v2,v3;customClaimMapping==MapValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) # example passing only required values which don't have defaults set try: - # Delete Data Source entity - api_instance.delete_entity_data_sources(id) + # Delete Identity Provider + api_instance.delete_entity_identity_providers(id) except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->delete_entity_data_sources: %s\n" % e) + print("Exception when calling OrganizationModelControllerApi->delete_entity_identity_providers: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Delete Data Source entity - api_instance.delete_entity_data_sources(id, filter=filter) + # Delete Identity Provider + api_instance.delete_entity_identity_providers(id, filter=filter) except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->delete_entity_data_sources: %s\n" % e) + print("Exception when calling OrganizationModelControllerApi->delete_entity_identity_providers: %s\n" % e) ``` @@ -1746,10 +1471,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_export_templates** -> delete_entity_export_templates(id) +# **delete_entity_llm_endpoints** +> delete_entity_llm_endpoints(id) + -Delete Export Template entity ### Example @@ -1771,22 +1496,20 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "title==someString;provider==LlmEndpointProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) # example passing only required values which don't have defaults set try: - # Delete Export Template entity - api_instance.delete_entity_export_templates(id) + api_instance.delete_entity_llm_endpoints(id) except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->delete_entity_export_templates: %s\n" % e) + print("Exception when calling OrganizationModelControllerApi->delete_entity_llm_endpoints: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Delete Export Template entity - api_instance.delete_entity_export_templates(id, filter=filter) + api_instance.delete_entity_llm_endpoints(id, filter=filter) except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->delete_entity_export_templates: %s\n" % e) + print("Exception when calling OrganizationModelControllerApi->delete_entity_llm_endpoints: %s\n" % e) ``` @@ -1819,10 +1542,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_identity_providers** -> delete_entity_identity_providers(id) +# **delete_entity_llm_providers** +> delete_entity_llm_providers(id) -Delete Identity Provider +Delete LLM Provider entity ### Example @@ -1844,22 +1567,22 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) id = "/6bUUGjjNSwg0_bs" # str | - filter = "identifiers==v1,v2,v3;customClaimMapping==MapValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) # example passing only required values which don't have defaults set try: - # Delete Identity Provider - api_instance.delete_entity_identity_providers(id) + # Delete LLM Provider entity + api_instance.delete_entity_llm_providers(id) except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->delete_entity_identity_providers: %s\n" % e) + print("Exception when calling OrganizationModelControllerApi->delete_entity_llm_providers: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Delete Identity Provider - api_instance.delete_entity_identity_providers(id, filter=filter) + # Delete LLM Provider entity + api_instance.delete_entity_llm_providers(id, filter=filter) except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->delete_entity_identity_providers: %s\n" % e) + print("Exception when calling OrganizationModelControllerApi->delete_entity_llm_providers: %s\n" % e) ``` @@ -1892,227 +1615,8 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_jwks** -> delete_entity_jwks(id) - -Delete Jwk - -Deletes JSON web key - used to verify JSON web tokens (Jwts) - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "content==JwkSpecificationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete Jwk - api_instance.delete_entity_jwks(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->delete_entity_jwks: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Delete Jwk - api_instance.delete_entity_jwks(id, filter=filter) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->delete_entity_jwks: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Successfully deleted | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_entity_llm_endpoints** -> delete_entity_llm_endpoints(id) - - - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "title==someString;provider==LlmEndpointProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - api_instance.delete_entity_llm_endpoints(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->delete_entity_llm_endpoints: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_instance.delete_entity_llm_endpoints(id, filter=filter) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->delete_entity_llm_endpoints: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Successfully deleted | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_entity_llm_providers** -> delete_entity_llm_providers(id) - -Delete LLM Provider entity - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete LLM Provider entity - api_instance.delete_entity_llm_providers(id) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->delete_entity_llm_providers: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Delete LLM Provider entity - api_instance.delete_entity_llm_providers(id, filter=filter) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->delete_entity_llm_providers: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Successfully deleted | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_entity_notification_channels** -> delete_entity_notification_channels(id) +# **delete_entity_notification_channels** +> delete_entity_notification_channels(id) Delete Notification Channel entity @@ -2705,83 +2209,6 @@ No authorization required - **Accept**: application/json, application/vnd.gooddata.api+json -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_entities_custom_geo_collections** -> JsonApiCustomGeoCollectionOutList get_all_entities_custom_geo_collections() - - - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_custom_geo_collection_out_list import JsonApiCustomGeoCollectionOutList -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.get_all_entities_custom_geo_collections(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->get_all_entities_custom_geo_collections: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiCustomGeoCollectionOutList**](JsonApiCustomGeoCollectionOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - ### HTTP response details | Status code | Description | Response headers | @@ -2868,170 +2295,12 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_all_entities_data_sources** -> JsonApiDataSourceOutList get_all_entities_data_sources() - -Get Data Source entities - -Data Source - represents data source for the workspace - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_data_source_out_list import JsonApiDataSourceOutList -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - filter = "name==someString;type==DatabaseTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=permissions,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get Data Source entities - api_response = api_instance.get_all_entities_data_sources(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->get_all_entities_data_sources: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiDataSourceOutList**](JsonApiDataSourceOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_entities_entitlements** -> JsonApiEntitlementOutList get_all_entities_entitlements() - -Get Entitlements - -Space of the shared interest - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_entitlement_out_list import JsonApiEntitlementOutList -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - filter = "value==someString;expiry==LocalDateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get Entitlements - api_response = api_instance.get_all_entities_entitlements(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->get_all_entities_entitlements: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiEntitlementOutList**](JsonApiEntitlementOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **get_all_entities_entitlements** +> JsonApiEntitlementOutList get_all_entities_entitlements() -# **get_all_entities_export_templates** -> JsonApiExportTemplateOutList get_all_entities_export_templates() +Get Entitlements -GET all Export Template entities +Space of the shared interest ### Example @@ -3040,7 +2309,7 @@ GET all Export Template entities import time import gooddata_api_client from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_export_template_out_list import JsonApiExportTemplateOutList +from gooddata_api_client.model.json_api_entitlement_out_list import JsonApiEntitlementOutList 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. @@ -3053,7 +2322,7 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - filter = "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "value==someString;expiry==LocalDateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 sort = [ @@ -3066,11 +2335,11 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # GET all Export Template entities - api_response = api_instance.get_all_entities_export_templates(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + # Get Entitlements + api_response = api_instance.get_all_entities_entitlements(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->get_all_entities_export_templates: %s\n" % e) + print("Exception when calling OrganizationModelControllerApi->get_all_entities_entitlements: %s\n" % e) ``` @@ -3086,7 +2355,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiExportTemplateOutList**](JsonApiExportTemplateOutList.md) +[**JsonApiEntitlementOutList**](JsonApiEntitlementOutList.md) ### Authorization @@ -3106,10 +2375,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_all_entities_identity_providers** -> JsonApiIdentityProviderOutList get_all_entities_identity_providers() +# **get_all_entities_export_templates** +> JsonApiExportTemplateOutList get_all_entities_export_templates() -Get all Identity Providers +GET all Export Template entities ### Example @@ -3118,7 +2387,7 @@ Get all Identity Providers import time import gooddata_api_client from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_identity_provider_out_list import JsonApiIdentityProviderOutList +from gooddata_api_client.model.json_api_export_template_out_list import JsonApiExportTemplateOutList 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. @@ -3131,7 +2400,7 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - filter = "identifiers==v1,v2,v3;customClaimMapping==MapValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 sort = [ @@ -3144,11 +2413,11 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Get all Identity Providers - api_response = api_instance.get_all_entities_identity_providers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + # GET all Export Template entities + api_response = api_instance.get_all_entities_export_templates(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->get_all_entities_identity_providers: %s\n" % e) + print("Exception when calling OrganizationModelControllerApi->get_all_entities_export_templates: %s\n" % e) ``` @@ -3164,7 +2433,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiIdentityProviderOutList**](JsonApiIdentityProviderOutList.md) +[**JsonApiExportTemplateOutList**](JsonApiExportTemplateOutList.md) ### Authorization @@ -3184,12 +2453,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_all_entities_jwks** -> JsonApiJwkOutList get_all_entities_jwks() - -Get all Jwks +# **get_all_entities_identity_providers** +> JsonApiIdentityProviderOutList get_all_entities_identity_providers() -Returns all JSON web keys - used to verify JSON web tokens (Jwts) +Get all Identity Providers ### Example @@ -3198,7 +2465,7 @@ Returns all JSON web keys - used to verify JSON web tokens (Jwts) import time import gooddata_api_client from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_jwk_out_list import JsonApiJwkOutList +from gooddata_api_client.model.json_api_identity_provider_out_list import JsonApiIdentityProviderOutList 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. @@ -3211,7 +2478,7 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - filter = "content==JwkSpecificationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "identifiers==v1,v2,v3;customClaimMapping==MapValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 sort = [ @@ -3224,11 +2491,11 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Get all Jwks - api_response = api_instance.get_all_entities_jwks(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + # Get all Identity Providers + api_response = api_instance.get_all_entities_identity_providers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->get_all_entities_jwks: %s\n" % e) + print("Exception when calling OrganizationModelControllerApi->get_all_entities_identity_providers: %s\n" % e) ``` @@ -3244,7 +2511,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiJwkOutList**](JsonApiJwkOutList.md) +[**JsonApiIdentityProviderOutList**](JsonApiIdentityProviderOutList.md) ### Authorization @@ -4209,80 +3476,6 @@ No authorization required - **Accept**: application/json, application/vnd.gooddata.api+json -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_entity_custom_geo_collections** -> JsonApiCustomGeoCollectionOutDocument get_entity_custom_geo_collections(id) - - - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_custom_geo_collection_out_document import JsonApiCustomGeoCollectionOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_entity_custom_geo_collections(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->get_entity_custom_geo_collections: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.get_entity_custom_geo_collections(id, filter=filter) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->get_entity_custom_geo_collections: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -[**JsonApiCustomGeoCollectionOutDocument**](JsonApiCustomGeoCollectionOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - ### HTTP response details | Status code | Description | Response headers | @@ -4363,88 +3556,6 @@ No authorization required - **Accept**: application/json, application/vnd.gooddata.api+json -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_entity_data_sources** -> JsonApiDataSourceOutDocument get_entity_data_sources(id) - -Get Data Source entity - -Data Source - represents data source for the workspace - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;type==DatabaseTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - meta_include = [ - "metaInclude=permissions,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get Data Source entity - api_response = api_instance.get_entity_data_sources(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->get_entity_data_sources: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get Data Source entity - api_response = api_instance.get_entity_data_sources(id, filter=filter, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->get_entity_data_sources: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiDataSourceOutDocument**](JsonApiDataSourceOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - ### HTTP response details | Status code | Description | Response headers | @@ -4619,85 +3730,7 @@ Get Identity Provider import time import gooddata_api_client from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "identifiers==v1,v2,v3;customClaimMapping==MapValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Get Identity Provider - api_response = api_instance.get_entity_identity_providers(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->get_entity_identity_providers: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get Identity Provider - api_response = api_instance.get_entity_identity_providers(id, filter=filter) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->get_entity_identity_providers: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -[**JsonApiIdentityProviderOutDocument**](JsonApiIdentityProviderOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_entity_jwks** -> JsonApiJwkOutDocument get_entity_jwks(id) - -Get Jwk - -Returns JSON web key - used to verify JSON web tokens (Jwts) - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument +from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument 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. @@ -4711,24 +3744,24 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) id = "/6bUUGjjNSwg0_bs" # str | - filter = "content==JwkSpecificationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "identifiers==v1,v2,v3;customClaimMapping==MapValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) # example passing only required values which don't have defaults set try: - # Get Jwk - api_response = api_instance.get_entity_jwks(id) + # Get Identity Provider + api_response = api_instance.get_entity_identity_providers(id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->get_entity_jwks: %s\n" % e) + print("Exception when calling OrganizationModelControllerApi->get_entity_identity_providers: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get Jwk - api_response = api_instance.get_entity_jwks(id, filter=filter) + # Get Identity Provider + api_response = api_instance.get_entity_identity_providers(id, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->get_entity_jwks: %s\n" % e) + print("Exception when calling OrganizationModelControllerApi->get_entity_identity_providers: %s\n" % e) ``` @@ -4741,7 +3774,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiJwkOutDocument**](JsonApiJwkOutDocument.md) +[**JsonApiIdentityProviderOutDocument**](JsonApiIdentityProviderOutDocument.md) ### Authorization @@ -5714,199 +4747,6 @@ No authorization required - **Accept**: application/json, application/vnd.gooddata.api+json -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **patch_entity_custom_geo_collections** -> JsonApiCustomGeoCollectionOutDocument patch_entity_custom_geo_collections(id, json_api_custom_geo_collection_patch_document) - - - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_custom_geo_collection_patch_document import JsonApiCustomGeoCollectionPatchDocument -from gooddata_api_client.model.json_api_custom_geo_collection_out_document import JsonApiCustomGeoCollectionOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_custom_geo_collection_patch_document = JsonApiCustomGeoCollectionPatchDocument( - data=JsonApiCustomGeoCollectionPatch( - attributes=JsonApiCustomGeoCollectionInAttributes( - description="description_example", - name="name_example", - ), - id="id1", - type="customGeoCollection", - ), - ) # JsonApiCustomGeoCollectionPatchDocument | - filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.patch_entity_custom_geo_collections(id, json_api_custom_geo_collection_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->patch_entity_custom_geo_collections: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.patch_entity_custom_geo_collections(id, json_api_custom_geo_collection_patch_document, filter=filter) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->patch_entity_custom_geo_collections: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_custom_geo_collection_patch_document** | [**JsonApiCustomGeoCollectionPatchDocument**](JsonApiCustomGeoCollectionPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -[**JsonApiCustomGeoCollectionOutDocument**](JsonApiCustomGeoCollectionOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **patch_entity_data_sources** -> JsonApiDataSourceOutDocument patch_entity_data_sources(id, json_api_data_source_patch_document) - -Patch Data Source entity - -Data Source - represents data source for the workspace - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_data_source_patch_document = JsonApiDataSourcePatchDocument( - data=JsonApiDataSourcePatch( - attributes=JsonApiDataSourcePatchAttributes( - alternative_data_source_id="pg_local_docker-demo2", - cache_strategy="ALWAYS", - client_id="client_id_example", - client_secret="client_secret_example", - name="name_example", - parameters=[ - JsonApiDataSourceInAttributesParametersInner( - name="name_example", - value="value_example", - ), - ], - password="password_example", - private_key="private_key_example", - private_key_passphrase="private_key_passphrase_example", - schema="schema_example", - token="token_example", - type="POSTGRESQL", - url="url_example", - username="username_example", - ), - id="id1", - type="dataSource", - ), - ) # JsonApiDataSourcePatchDocument | - filter = "name==someString;type==DatabaseTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Data Source entity - api_response = api_instance.patch_entity_data_sources(id, json_api_data_source_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->patch_entity_data_sources: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Patch Data Source entity - api_response = api_instance.patch_entity_data_sources(id, json_api_data_source_patch_document, filter=filter) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->patch_entity_data_sources: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_data_source_patch_document** | [**JsonApiDataSourcePatchDocument**](JsonApiDataSourcePatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -[**JsonApiDataSourceOutDocument**](JsonApiDataSourceOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - ### HTTP response details | Status code | Description | Response headers | @@ -6032,113 +4872,10 @@ with gooddata_api_client.ApiClient() as api_client: # and optional values try: # Patch Export Template entity - api_response = api_instance.patch_entity_export_templates(id, json_api_export_template_patch_document, filter=filter) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->patch_entity_export_templates: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_export_template_patch_document** | [**JsonApiExportTemplatePatchDocument**](JsonApiExportTemplatePatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -[**JsonApiExportTemplateOutDocument**](JsonApiExportTemplateOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **patch_entity_identity_providers** -> JsonApiIdentityProviderOutDocument patch_entity_identity_providers(id, json_api_identity_provider_patch_document) - -Patch Identity Provider - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_identity_provider_patch_document import JsonApiIdentityProviderPatchDocument -from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_identity_provider_patch_document = JsonApiIdentityProviderPatchDocument( - data=JsonApiIdentityProviderPatch( - attributes=JsonApiIdentityProviderInAttributes( - custom_claim_mapping={ - "key": "key_example", - }, - identifiers=["gooddata.com"], - idp_type="MANAGED_IDP", - oauth_client_id="oauth_client_id_example", - oauth_client_secret="oauth_client_secret_example", - oauth_custom_auth_attributes={ - "key": "key_example", - }, - oauth_custom_scopes=[ - "oauth_custom_scopes_example", - ], - oauth_issuer_id="myOidcProvider", - oauth_issuer_location="oauth_issuer_location_example", - oauth_subject_id_claim="oid", - saml_metadata="saml_metadata_example", - ), - id="id1", - type="identityProvider", - ), - ) # JsonApiIdentityProviderPatchDocument | - filter = "identifiers==v1,v2,v3;customClaimMapping==MapValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Identity Provider - api_response = api_instance.patch_entity_identity_providers(id, json_api_identity_provider_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->patch_entity_identity_providers: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Patch Identity Provider - api_response = api_instance.patch_entity_identity_providers(id, json_api_identity_provider_patch_document, filter=filter) + api_response = api_instance.patch_entity_export_templates(id, json_api_export_template_patch_document, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->patch_entity_identity_providers: %s\n" % e) + print("Exception when calling OrganizationModelControllerApi->patch_entity_export_templates: %s\n" % e) ``` @@ -6147,12 +4884,12 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **str**| | - **json_api_identity_provider_patch_document** | [**JsonApiIdentityProviderPatchDocument**](JsonApiIdentityProviderPatchDocument.md)| | + **json_api_export_template_patch_document** | [**JsonApiExportTemplatePatchDocument**](JsonApiExportTemplatePatchDocument.md)| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type -[**JsonApiIdentityProviderOutDocument**](JsonApiIdentityProviderOutDocument.md) +[**JsonApiExportTemplateOutDocument**](JsonApiExportTemplateOutDocument.md) ### Authorization @@ -6172,12 +4909,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **patch_entity_jwks** -> JsonApiJwkOutDocument patch_entity_jwks(id, json_api_jwk_patch_document) - -Patch Jwk +# **patch_entity_identity_providers** +> JsonApiIdentityProviderOutDocument patch_entity_identity_providers(id, json_api_identity_provider_patch_document) -Patches JSON web key - used to verify JSON web tokens (Jwts) +Patch Identity Provider ### Example @@ -6186,8 +4921,8 @@ Patches JSON web key - used to verify JSON web tokens (Jwts) import time import gooddata_api_client from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_jwk_patch_document import JsonApiJwkPatchDocument -from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument +from gooddata_api_client.model.json_api_identity_provider_patch_document import JsonApiIdentityProviderPatchDocument +from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument 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. @@ -6201,33 +4936,49 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) id = "/6bUUGjjNSwg0_bs" # str | - json_api_jwk_patch_document = JsonApiJwkPatchDocument( - data=JsonApiJwkPatch( - attributes=JsonApiJwkInAttributes( - content=JsonApiJwkInAttributesContent(), + json_api_identity_provider_patch_document = JsonApiIdentityProviderPatchDocument( + data=JsonApiIdentityProviderPatch( + attributes=JsonApiIdentityProviderInAttributes( + custom_claim_mapping={ + "key": "key_example", + }, + identifiers=["gooddata.com"], + idp_type="MANAGED_IDP", + oauth_client_id="oauth_client_id_example", + oauth_client_secret="oauth_client_secret_example", + oauth_custom_auth_attributes={ + "key": "key_example", + }, + oauth_custom_scopes=[ + "oauth_custom_scopes_example", + ], + oauth_issuer_id="myOidcProvider", + oauth_issuer_location="oauth_issuer_location_example", + oauth_subject_id_claim="oid", + saml_metadata="saml_metadata_example", ), id="id1", - type="jwk", + type="identityProvider", ), - ) # JsonApiJwkPatchDocument | - filter = "content==JwkSpecificationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + ) # JsonApiIdentityProviderPatchDocument | + filter = "identifiers==v1,v2,v3;customClaimMapping==MapValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) # example passing only required values which don't have defaults set try: - # Patch Jwk - api_response = api_instance.patch_entity_jwks(id, json_api_jwk_patch_document) + # Patch Identity Provider + api_response = api_instance.patch_entity_identity_providers(id, json_api_identity_provider_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->patch_entity_jwks: %s\n" % e) + print("Exception when calling OrganizationModelControllerApi->patch_entity_identity_providers: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Patch Jwk - api_response = api_instance.patch_entity_jwks(id, json_api_jwk_patch_document, filter=filter) + # Patch Identity Provider + api_response = api_instance.patch_entity_identity_providers(id, json_api_identity_provider_patch_document, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->patch_entity_jwks: %s\n" % e) + print("Exception when calling OrganizationModelControllerApi->patch_entity_identity_providers: %s\n" % e) ``` @@ -6236,12 +4987,12 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **str**| | - **json_api_jwk_patch_document** | [**JsonApiJwkPatchDocument**](JsonApiJwkPatchDocument.md)| | + **json_api_identity_provider_patch_document** | [**JsonApiIdentityProviderPatchDocument**](JsonApiIdentityProviderPatchDocument.md)| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type -[**JsonApiJwkOutDocument**](JsonApiJwkOutDocument.md) +[**JsonApiIdentityProviderOutDocument**](JsonApiIdentityProviderOutDocument.md) ### Authorization @@ -6382,7 +5133,7 @@ with gooddata_api_client.ApiClient() as api_client: id = "/6bUUGjjNSwg0_bs" # str | json_api_llm_provider_patch_document = JsonApiLlmProviderPatchDocument( data=JsonApiLlmProviderPatch( - attributes=JsonApiLlmProviderPatchAttributes( + attributes=JsonApiLlmProviderInAttributes( default_model_id="default_model_id_example", description="description_example", models=[ @@ -7210,199 +5961,6 @@ No authorization required - **Accept**: application/json, application/vnd.gooddata.api+json -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_entity_custom_geo_collections** -> JsonApiCustomGeoCollectionOutDocument update_entity_custom_geo_collections(id, json_api_custom_geo_collection_in_document) - - - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_custom_geo_collection_out_document import JsonApiCustomGeoCollectionOutDocument -from gooddata_api_client.model.json_api_custom_geo_collection_in_document import JsonApiCustomGeoCollectionInDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_custom_geo_collection_in_document = JsonApiCustomGeoCollectionInDocument( - data=JsonApiCustomGeoCollectionIn( - attributes=JsonApiCustomGeoCollectionInAttributes( - description="description_example", - name="name_example", - ), - id="id1", - type="customGeoCollection", - ), - ) # JsonApiCustomGeoCollectionInDocument | - filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.update_entity_custom_geo_collections(id, json_api_custom_geo_collection_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->update_entity_custom_geo_collections: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.update_entity_custom_geo_collections(id, json_api_custom_geo_collection_in_document, filter=filter) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->update_entity_custom_geo_collections: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_custom_geo_collection_in_document** | [**JsonApiCustomGeoCollectionInDocument**](JsonApiCustomGeoCollectionInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -[**JsonApiCustomGeoCollectionOutDocument**](JsonApiCustomGeoCollectionOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_entity_data_sources** -> JsonApiDataSourceOutDocument update_entity_data_sources(id, json_api_data_source_in_document) - -Put Data Source entity - -Data Source - represents data source for the workspace - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_data_source_in_document import JsonApiDataSourceInDocument -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_data_source_in_document = JsonApiDataSourceInDocument( - data=JsonApiDataSourceIn( - attributes=JsonApiDataSourceInAttributes( - alternative_data_source_id="pg_local_docker-demo2", - cache_strategy="ALWAYS", - client_id="client_id_example", - client_secret="client_secret_example", - name="name_example", - parameters=[ - JsonApiDataSourceInAttributesParametersInner( - name="name_example", - value="value_example", - ), - ], - password="password_example", - private_key="private_key_example", - private_key_passphrase="private_key_passphrase_example", - schema="schema_example", - token="token_example", - type="POSTGRESQL", - url="url_example", - username="username_example", - ), - id="id1", - type="dataSource", - ), - ) # JsonApiDataSourceInDocument | - filter = "name==someString;type==DatabaseTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put Data Source entity - api_response = api_instance.update_entity_data_sources(id, json_api_data_source_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->update_entity_data_sources: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Put Data Source entity - api_response = api_instance.update_entity_data_sources(id, json_api_data_source_in_document, filter=filter) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->update_entity_data_sources: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_data_source_in_document** | [**JsonApiDataSourceInDocument**](JsonApiDataSourceInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -[**JsonApiDataSourceOutDocument**](JsonApiDataSourceOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - ### HTTP response details | Status code | Description | Response headers | @@ -7660,95 +6218,6 @@ No authorization required - **Accept**: application/json, application/vnd.gooddata.api+json -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_entity_jwks** -> JsonApiJwkOutDocument update_entity_jwks(id, json_api_jwk_in_document) - -Put Jwk - -Updates JSON web key - used to verify JSON web tokens (Jwts) - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import organization_model_controller_api -from gooddata_api_client.model.json_api_jwk_in_document import JsonApiJwkInDocument -from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_jwk_in_document = JsonApiJwkInDocument( - data=JsonApiJwkIn( - attributes=JsonApiJwkInAttributes( - content=JsonApiJwkInAttributesContent(), - ), - id="id1", - type="jwk", - ), - ) # JsonApiJwkInDocument | - filter = "content==JwkSpecificationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put Jwk - api_response = api_instance.update_entity_jwks(id, json_api_jwk_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->update_entity_jwks: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Put Jwk - api_response = api_instance.update_entity_jwks(id, json_api_jwk_in_document, filter=filter) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling OrganizationModelControllerApi->update_entity_jwks: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_jwk_in_document** | [**JsonApiJwkInDocument**](JsonApiJwkInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -[**JsonApiJwkOutDocument**](JsonApiJwkOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/PluginsApi.md b/gooddata-api-client/docs/PluginsApi.md index a558fc701..898f2ff27 100644 --- a/gooddata-api-client/docs/PluginsApi.md +++ b/gooddata-api-client/docs/PluginsApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description [**get_all_entities_dashboard_plugins**](PluginsApi.md#get_all_entities_dashboard_plugins) | **GET** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins | Get all Plugins [**get_entity_dashboard_plugins**](PluginsApi.md#get_entity_dashboard_plugins) | **GET** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Get a Plugin [**patch_entity_dashboard_plugins**](PluginsApi.md#patch_entity_dashboard_plugins) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Patch a Plugin -[**search_entities_dashboard_plugins**](PluginsApi.md#search_entities_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search | Search request for DashboardPlugin +[**search_entities_dashboard_plugins**](PluginsApi.md#search_entities_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search | The search endpoint (beta) [**update_entity_dashboard_plugins**](PluginsApi.md#update_entity_dashboard_plugins) | **PUT** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Put a Plugin @@ -473,7 +473,7 @@ No authorization required # **search_entities_dashboard_plugins** > JsonApiDashboardPluginOutList search_entities_dashboard_plugins(workspace_id, entity_search_body) -Search request for DashboardPlugin +The search endpoint (beta) ### Example @@ -521,7 +521,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Search request for DashboardPlugin + # The search endpoint (beta) api_response = api_instance.search_entities_dashboard_plugins(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -530,7 +530,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Search request for DashboardPlugin + # The search endpoint (beta) api_response = api_instance.search_entities_dashboard_plugins(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/RichTextWidgetDescriptor.md b/gooddata-api-client/docs/RichTextWidgetDescriptor.md new file mode 100644 index 000000000..e0b482541 --- /dev/null +++ b/gooddata-api-client/docs/RichTextWidgetDescriptor.md @@ -0,0 +1,15 @@ +# RichTextWidgetDescriptor + +Rich text widget displaying static content. Has no execution result. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**title** | **str** | Widget title as displayed on the dashboard. | +**widget_id** | **str** | Widget object ID. | +**widget_type** | **str** | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/RichTextWidgetDescriptorAllOf.md b/gooddata-api-client/docs/RichTextWidgetDescriptorAllOf.md new file mode 100644 index 000000000..06f207309 --- /dev/null +++ b/gooddata-api-client/docs/RichTextWidgetDescriptorAllOf.md @@ -0,0 +1,13 @@ +# RichTextWidgetDescriptorAllOf + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**title** | **str** | Widget title as displayed on the dashboard. | [optional] +**widget_id** | **str** | Widget object ID. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/Settings.md b/gooddata-api-client/docs/Settings.md index fa4938a41..b09117f5e 100644 --- a/gooddata-api-client/docs/Settings.md +++ b/gooddata-api-client/docs/Settings.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **delimiter** | **str** | Set column delimiter. (CSV) | [optional] **export_info** | **bool** | If true, the export will contain the information about the export – exported date, filters, etc. Works only with `visualizationObject`. (XLSX, PDF) | [optional] if omitted the server will use the default value of False +**grand_totals_position** | **str** | Grand totals position. Takes precedence over position specified in visualization. | [optional] **merge_headers** | **bool** | Merge equal headers in neighbouring cells. (XLSX) | [optional] **page_orientation** | **str** | Set page orientation. (PDF) | [optional] if omitted the server will use the default value of "PORTRAIT" **page_size** | **str** | Set page size. (PDF) | [optional] if omitted the server will use the default value of "A4" diff --git a/gooddata-api-client/docs/SmartFunctionsApi.md b/gooddata-api-client/docs/SmartFunctionsApi.md index ad6b146b9..b8c353cc8 100644 --- a/gooddata-api-client/docs/SmartFunctionsApi.md +++ b/gooddata-api-client/docs/SmartFunctionsApi.md @@ -20,11 +20,14 @@ Method | HTTP request | Description [**generate_title**](SmartFunctionsApi.md#generate_title) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/generateTitle | Generate Title for Analytics Object [**get_quality_issues**](SmartFunctionsApi.md#get_quality_issues) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/issues | Get Quality Issues [**get_quality_issues_calculation_status**](SmartFunctionsApi.md#get_quality_issues_calculation_status) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/issues/status/{processId} | Get Quality Issues Calculation Status +[**list_llm_provider_models**](SmartFunctionsApi.md#list_llm_provider_models) | **POST** /api/v1/actions/ai/llmProvider/listModels | List LLM Provider Models +[**list_llm_provider_models_by_id**](SmartFunctionsApi.md#list_llm_provider_models_by_id) | **POST** /api/v1/actions/ai/llmProvider/{llmProviderId}/listModels | List LLM Provider Models By Id [**memory_created_by_users**](SmartFunctionsApi.md#memory_created_by_users) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/memory/createdBy | Get AI Memory CreatedBy Users [**resolve_llm_endpoints**](SmartFunctionsApi.md#resolve_llm_endpoints) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmEndpoints | Get Active LLM Endpoints for this workspace [**tags**](SmartFunctionsApi.md#tags) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/tags | Get Analytics Catalog Tags [**test_llm_provider**](SmartFunctionsApi.md#test_llm_provider) | **POST** /api/v1/actions/ai/llmProvider/test | Test LLM Provider [**test_llm_provider_by_id**](SmartFunctionsApi.md#test_llm_provider_by_id) | **POST** /api/v1/actions/ai/llmProvider/{llmProviderId}/test | Test LLM Provider By Id +[**trending_objects**](SmartFunctionsApi.md#trending_objects) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/trendingObjects | Get Trending Analytics Catalog Objects [**trigger_quality_issues_calculation**](SmartFunctionsApi.md#trigger_quality_issues_calculation) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/issues/triggerCheck | Trigger Quality Issues Calculation [**validate_llm_endpoint**](SmartFunctionsApi.md#validate_llm_endpoint) | **POST** /api/v1/actions/ai/llmEndpoint/test | Validate LLM Endpoint [**validate_llm_endpoint_by_id**](SmartFunctionsApi.md#validate_llm_endpoint_by_id) | **POST** /api/v1/actions/ai/llmEndpoint/{llmEndpointId}/test | Validate LLM Endpoint By Id @@ -85,6 +88,28 @@ with gooddata_api_client.ApiClient() as api_client: type="type_example", workspace_id="workspace_id_example", ), + referenced_objects=[ + ObjectReferenceGroup( + context=ObjectReference( + id="id_example", + type="WIDGET", + ), + objects=[ + ObjectReference( + id="id_example", + type="WIDGET", + ), + ], + ), + ], + view=UIContext( + dashboard=DashboardContext( + id="id_example", + widgets=[ + DashboardContextWidgetsInner(None), + ], + ), + ), ), ) # ChatRequest | @@ -262,6 +287,28 @@ with gooddata_api_client.ApiClient() as api_client: type="type_example", workspace_id="workspace_id_example", ), + referenced_objects=[ + ObjectReferenceGroup( + context=ObjectReference( + id="id_example", + type="WIDGET", + ), + objects=[ + ObjectReference( + id="id_example", + type="WIDGET", + ), + ], + ), + ], + view=UIContext( + dashboard=DashboardContext( + id="id_example", + widgets=[ + DashboardContextWidgetsInner(None), + ], + ), + ), ), ) # ChatRequest | @@ -1310,6 +1357,143 @@ No authorization required - **Accept**: application/json +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_llm_provider_models** +> ListLlmProviderModelsResponse list_llm_provider_models(list_llm_provider_models_request) + +List LLM Provider Models + +Lists models available on an LLM provider with a full definition. For Azure AI Foundry providers, the model family will be set to UNKNOWN because the endpoint does not expose the family. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import smart_functions_api +from gooddata_api_client.model.list_llm_provider_models_request import ListLlmProviderModelsRequest +from gooddata_api_client.model.list_llm_provider_models_response import ListLlmProviderModelsResponse +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = smart_functions_api.SmartFunctionsApi(api_client) + list_llm_provider_models_request = ListLlmProviderModelsRequest( + provider_config=ListLlmProviderModelsRequestProviderConfig(None), + ) # ListLlmProviderModelsRequest | + + # example passing only required values which don't have defaults set + try: + # List LLM Provider Models + api_response = api_instance.list_llm_provider_models(list_llm_provider_models_request) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->list_llm_provider_models: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **list_llm_provider_models_request** | [**ListLlmProviderModelsRequest**](ListLlmProviderModelsRequest.md)| | + +### Return type + +[**ListLlmProviderModelsResponse**](ListLlmProviderModelsResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_llm_provider_models_by_id** +> ListLlmProviderModelsResponse list_llm_provider_models_by_id(llm_provider_id) + +List LLM Provider Models By Id + +Lists models available on an existing LLM provider by its ID. For Azure AI Foundry providers, the model family will be set to UNKNOWN because the endpoint does not expose the family. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import smart_functions_api +from gooddata_api_client.model.list_llm_provider_models_response import ListLlmProviderModelsResponse +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = smart_functions_api.SmartFunctionsApi(api_client) + llm_provider_id = "llmProviderId_example" # str | + + # example passing only required values which don't have defaults set + try: + # List LLM Provider Models By Id + api_response = api_instance.list_llm_provider_models_by_id(llm_provider_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->list_llm_provider_models_by_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **llm_provider_id** | **str**| | + +### Return type + +[**ListLlmProviderModelsResponse**](ListLlmProviderModelsResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + ### HTTP response details | Status code | Description | Response headers | @@ -1554,7 +1738,7 @@ with gooddata_api_client.ApiClient() as api_client: id="id_example", ), ], - provider_config=TestLlmProviderDefinitionRequestProviderConfig(None), + provider_config=ListLlmProviderModelsRequestProviderConfig(None), ) # TestLlmProviderDefinitionRequest | # example passing only required values which don't have defaults set @@ -1610,6 +1794,7 @@ import time import gooddata_api_client from gooddata_api_client.api import smart_functions_api from gooddata_api_client.model.test_llm_provider_response import TestLlmProviderResponse +from gooddata_api_client.model.test_llm_provider_by_id_request import TestLlmProviderByIdRequest 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. @@ -1623,6 +1808,15 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = smart_functions_api.SmartFunctionsApi(api_client) llm_provider_id = "llmProviderId_example" # str | + test_llm_provider_by_id_request = TestLlmProviderByIdRequest( + models=[ + LlmModel( + family="OPENAI", + id="id_example", + ), + ], + provider_config=ListLlmProviderModelsRequestProviderConfig(None), + ) # TestLlmProviderByIdRequest | (optional) # example passing only required values which don't have defaults set try: @@ -1631,6 +1825,15 @@ with gooddata_api_client.ApiClient() as api_client: pprint(api_response) except gooddata_api_client.ApiException as e: print("Exception when calling SmartFunctionsApi->test_llm_provider_by_id: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Test LLM Provider By Id + api_response = api_instance.test_llm_provider_by_id(llm_provider_id, test_llm_provider_by_id_request=test_llm_provider_by_id_request) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->test_llm_provider_by_id: %s\n" % e) ``` @@ -1639,6 +1842,7 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **llm_provider_id** | **str**| | + **test_llm_provider_by_id_request** | [**TestLlmProviderByIdRequest**](TestLlmProviderByIdRequest.md)| | [optional] ### Return type @@ -1648,6 +1852,73 @@ Name | Type | Description | Notes No authorization required +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **trending_objects** +> TrendingObjectsResult trending_objects(workspace_id) + +Get Trending Analytics Catalog Objects + +Returns a list of trending objects for this workspace + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import smart_functions_api +from gooddata_api_client.model.trending_objects_result import TrendingObjectsResult +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = smart_functions_api.SmartFunctionsApi(api_client) + workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier + + # example passing only required values which don't have defaults set + try: + # Get Trending Analytics Catalog Objects + api_response = api_instance.trending_objects(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->trending_objects: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| Workspace identifier | + +### Return type + +[**TrendingObjectsResult**](TrendingObjectsResult.md) + +### Authorization + +No authorization required + ### HTTP request headers - **Content-Type**: Not defined diff --git a/gooddata-api-client/docs/TabularExportApi.md b/gooddata-api-client/docs/TabularExportApi.md index 40bab308f..2151d2a9c 100644 --- a/gooddata-api-client/docs/TabularExportApi.md +++ b/gooddata-api-client/docs/TabularExportApi.md @@ -152,6 +152,7 @@ with gooddata_api_client.ApiClient() as api_client: settings=Settings( delimiter="U", export_info=True, + grand_totals_position="pinnedBottom", merge_headers=True, page_orientation="PORTRAIT", page_size="A4", diff --git a/gooddata-api-client/docs/TestLlmProviderByIdRequest.md b/gooddata-api-client/docs/TestLlmProviderByIdRequest.md new file mode 100644 index 000000000..a4b9e4929 --- /dev/null +++ b/gooddata-api-client/docs/TestLlmProviderByIdRequest.md @@ -0,0 +1,13 @@ +# TestLlmProviderByIdRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**models** | [**[LlmModel]**](LlmModel.md) | Models overrides. | [optional] +**provider_config** | [**ListLlmProviderModelsRequestProviderConfig**](ListLlmProviderModelsRequestProviderConfig.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/TestLlmProviderDefinitionRequest.md b/gooddata-api-client/docs/TestLlmProviderDefinitionRequest.md index 3045f7af8..809a7d1df 100644 --- a/gooddata-api-client/docs/TestLlmProviderDefinitionRequest.md +++ b/gooddata-api-client/docs/TestLlmProviderDefinitionRequest.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**provider_config** | [**TestLlmProviderDefinitionRequestProviderConfig**](TestLlmProviderDefinitionRequestProviderConfig.md) | | +**provider_config** | [**ListLlmProviderModelsRequestProviderConfig**](ListLlmProviderModelsRequestProviderConfig.md) | | **models** | [**[LlmModel]**](LlmModel.md) | Models to test. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/gooddata-api-client/docs/TrendingObjectItem.md b/gooddata-api-client/docs/TrendingObjectItem.md new file mode 100644 index 000000000..ff577d66f --- /dev/null +++ b/gooddata-api-client/docs/TrendingObjectItem.md @@ -0,0 +1,30 @@ +# TrendingObjectItem + +Trending analytics catalog objects + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Object ID. | +**tags** | **[str]** | | +**title** | **str** | Object title. | +**type** | **str** | Object type, e.g. dashboard, visualization, metric. | +**usage_count** | **int** | Number of times this object has been used/referenced. | +**workspace_id** | **str** | Workspace ID the object belongs to. | +**created_at** | **datetime** | Timestamp when object was created. | [optional] +**created_by** | **str** | ID of the user who created the object. | [optional] +**dataset_id** | **str** | ID of the associated dataset, if applicable. | [optional] +**dataset_title** | **str** | Title of the associated dataset, if applicable. | [optional] +**dataset_type** | **str** | Type of the associated dataset, if applicable. | [optional] +**description** | **str** | Object description. | [optional] +**is_hidden** | **bool** | If true, this object is hidden from AI search results by default. | [optional] +**is_hidden_from_kda** | **bool** | If true, this object is hidden from KDA. | [optional] +**metric_type** | **str** | Type of the metric (e.g. MAQL), if applicable. | [optional] +**modified_at** | **datetime** | Timestamp when object was last modified. | [optional] +**modified_by** | **str** | ID of the user who last modified the object. | [optional] +**visualization_url** | **str** | URL of the visualization, if applicable. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/TrendingObjectsResult.md b/gooddata-api-client/docs/TrendingObjectsResult.md new file mode 100644 index 000000000..8c33e779f --- /dev/null +++ b/gooddata-api-client/docs/TrendingObjectsResult.md @@ -0,0 +1,12 @@ +# TrendingObjectsResult + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**objects** | [**[TrendingObjectItem]**](TrendingObjectItem.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/UIContext.md b/gooddata-api-client/docs/UIContext.md new file mode 100644 index 000000000..35c989c34 --- /dev/null +++ b/gooddata-api-client/docs/UIContext.md @@ -0,0 +1,13 @@ +# UIContext + +Ambient UI state: what the user is currently looking at (dashboard, visible widgets). + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**dashboard** | [**DashboardContext**](DashboardContext.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/UserContext.md b/gooddata-api-client/docs/UserContext.md index 887cb2b08..33367ffdf 100644 --- a/gooddata-api-client/docs/UserContext.md +++ b/gooddata-api-client/docs/UserContext.md @@ -1,11 +1,13 @@ # UserContext -User context, which can affect the behavior of the underlying AI features. +User context with ambient UI state (view) and explicitly referenced objects. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**active_object** | [**ActiveObjectIdentification**](ActiveObjectIdentification.md) | | +**referenced_objects** | [**[ObjectReferenceGroup]**](ObjectReferenceGroup.md) | Groups of explicitly referenced objects, each optionally scoped by a context (e.g. a dashboard context with widget references). | +**active_object** | [**ActiveObjectIdentification**](ActiveObjectIdentification.md) | | [optional] +**view** | [**UIContext**](UIContext.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/UserDataFilterControllerApi.md b/gooddata-api-client/docs/UserDataFilterControllerApi.md new file mode 100644 index 000000000..494cf1cff --- /dev/null +++ b/gooddata-api-client/docs/UserDataFilterControllerApi.md @@ -0,0 +1,694 @@ +# gooddata_api_client.UserDataFilterControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_user_data_filters**](UserDataFilterControllerApi.md#create_entity_user_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/userDataFilters | Post User Data Filters +[**delete_entity_user_data_filters**](UserDataFilterControllerApi.md#delete_entity_user_data_filters) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Delete a User Data Filter +[**get_all_entities_user_data_filters**](UserDataFilterControllerApi.md#get_all_entities_user_data_filters) | **GET** /api/v1/entities/workspaces/{workspaceId}/userDataFilters | Get all User Data Filters +[**get_entity_user_data_filters**](UserDataFilterControllerApi.md#get_entity_user_data_filters) | **GET** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Get a User Data Filter +[**patch_entity_user_data_filters**](UserDataFilterControllerApi.md#patch_entity_user_data_filters) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Patch a User Data Filter +[**search_entities_user_data_filters**](UserDataFilterControllerApi.md#search_entities_user_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/search | The search endpoint (beta) +[**update_entity_user_data_filters**](UserDataFilterControllerApi.md#update_entity_user_data_filters) | **PUT** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Put a User Data Filter + + +# **create_entity_user_data_filters** +> JsonApiUserDataFilterOutDocument create_entity_user_data_filters(workspace_id, json_api_user_data_filter_post_optional_id_document) + +Post User Data Filters + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import user_data_filter_controller_api +from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.model.json_api_user_data_filter_post_optional_id_document import JsonApiUserDataFilterPostOptionalIdDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = user_data_filter_controller_api.UserDataFilterControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + json_api_user_data_filter_post_optional_id_document = JsonApiUserDataFilterPostOptionalIdDocument( + data=JsonApiUserDataFilterPostOptionalId( + attributes=JsonApiUserDataFilterInAttributes( + are_relations_valid=True, + description="description_example", + maql="maql_example", + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + relationships=JsonApiUserDataFilterInRelationships( + user=JsonApiFilterViewInRelationshipsUser( + data=JsonApiUserToOneLinkage(None), + ), + user_group=JsonApiOrganizationOutRelationshipsBootstrapUserGroup( + data=JsonApiUserGroupToOneLinkage(None), + ), + ), + type="userDataFilter", + ), + ) # JsonApiUserDataFilterPostOptionalIdDocument | + include = [ + "user,userGroup,facts,attributes,labels,metrics,datasets", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post User Data Filters + api_response = api_instance.create_entity_user_data_filters(workspace_id, json_api_user_data_filter_post_optional_id_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserDataFilterControllerApi->create_entity_user_data_filters: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post User Data Filters + api_response = api_instance.create_entity_user_data_filters(workspace_id, json_api_user_data_filter_post_optional_id_document, include=include, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserDataFilterControllerApi->create_entity_user_data_filters: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_user_data_filter_post_optional_id_document** | [**JsonApiUserDataFilterPostOptionalIdDocument**](JsonApiUserDataFilterPostOptionalIdDocument.md)| | + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiUserDataFilterOutDocument**](JsonApiUserDataFilterOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_entity_user_data_filters** +> delete_entity_user_data_filters(workspace_id, object_id) + +Delete a User Data Filter + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import user_data_filter_controller_api +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = user_data_filter_controller_api.UserDataFilterControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;user.id==321;userGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Delete a User Data Filter + api_instance.delete_entity_user_data_filters(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserDataFilterControllerApi->delete_entity_user_data_filters: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete a User Data Filter + api_instance.delete_entity_user_data_filters(workspace_id, object_id, filter=filter) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserDataFilterControllerApi->delete_entity_user_data_filters: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successfully deleted | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_entities_user_data_filters** +> JsonApiUserDataFilterOutList get_all_entities_user_data_filters(workspace_id) + +Get all User Data Filters + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import user_data_filter_controller_api +from gooddata_api_client.model.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = user_data_filter_controller_api.UserDataFilterControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString;user.id==321;userGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "user,userGroup,facts,attributes,labels,metrics,datasets", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get all User Data Filters + api_response = api_instance.get_all_entities_user_data_filters(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserDataFilterControllerApi->get_all_entities_user_data_filters: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all User Data Filters + api_response = api_instance.get_all_entities_user_data_filters(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserDataFilterControllerApi->get_all_entities_user_data_filters: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiUserDataFilterOutList**](JsonApiUserDataFilterOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_user_data_filters** +> JsonApiUserDataFilterOutDocument get_entity_user_data_filters(workspace_id, object_id) + +Get a User Data Filter + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import user_data_filter_controller_api +from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = user_data_filter_controller_api.UserDataFilterControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;user.id==321;userGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "user,userGroup,facts,attributes,labels,metrics,datasets", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a User Data Filter + api_response = api_instance.get_entity_user_data_filters(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserDataFilterControllerApi->get_entity_user_data_filters: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a User Data Filter + api_response = api_instance.get_entity_user_data_filters(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserDataFilterControllerApi->get_entity_user_data_filters: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiUserDataFilterOutDocument**](JsonApiUserDataFilterOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **patch_entity_user_data_filters** +> JsonApiUserDataFilterOutDocument patch_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_patch_document) + +Patch a User Data Filter + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import user_data_filter_controller_api +from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.model.json_api_user_data_filter_patch_document import JsonApiUserDataFilterPatchDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = user_data_filter_controller_api.UserDataFilterControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_user_data_filter_patch_document = JsonApiUserDataFilterPatchDocument( + data=JsonApiUserDataFilterPatch( + attributes=JsonApiUserDataFilterPatchAttributes( + are_relations_valid=True, + description="description_example", + maql="maql_example", + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + relationships=JsonApiUserDataFilterInRelationships( + user=JsonApiFilterViewInRelationshipsUser( + data=JsonApiUserToOneLinkage(None), + ), + user_group=JsonApiOrganizationOutRelationshipsBootstrapUserGroup( + data=JsonApiUserGroupToOneLinkage(None), + ), + ), + type="userDataFilter", + ), + ) # JsonApiUserDataFilterPatchDocument | + filter = "title==someString;description==someString;user.id==321;userGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "user,userGroup,facts,attributes,labels,metrics,datasets", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Patch a User Data Filter + api_response = api_instance.patch_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserDataFilterControllerApi->patch_entity_user_data_filters: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch a User Data Filter + api_response = api_instance.patch_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserDataFilterControllerApi->patch_entity_user_data_filters: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_user_data_filter_patch_document** | [**JsonApiUserDataFilterPatchDocument**](JsonApiUserDataFilterPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiUserDataFilterOutDocument**](JsonApiUserDataFilterOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **search_entities_user_data_filters** +> JsonApiUserDataFilterOutList search_entities_user_data_filters(workspace_id, entity_search_body) + +The search endpoint (beta) + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import user_data_filter_controller_api +from gooddata_api_client.model.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = user_data_filter_controller_api.UserDataFilterControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + entity_search_body = EntitySearchBody( + filter="filter_example", + include=[ + "include_example", + ], + meta_include=[ + "meta_include_example", + ], + page=EntitySearchPage( + index=0, + size=100, + ), + sort=[ + EntitySearchSort( + direction="ASC", + _property="_property_example", + ), + ], + ) # EntitySearchBody | Search request body with filter, pagination, and sorting options + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_user_data_filters(workspace_id, entity_search_body) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserDataFilterControllerApi->search_entities_user_data_filters: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_user_data_filters(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserDataFilterControllerApi->search_entities_user_data_filters: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + +### Return type + +[**JsonApiUserDataFilterOutList**](JsonApiUserDataFilterOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_entity_user_data_filters** +> JsonApiUserDataFilterOutDocument update_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_in_document) + +Put a User Data Filter + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import user_data_filter_controller_api +from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.model.json_api_user_data_filter_in_document import JsonApiUserDataFilterInDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = user_data_filter_controller_api.UserDataFilterControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_user_data_filter_in_document = JsonApiUserDataFilterInDocument( + data=JsonApiUserDataFilterIn( + attributes=JsonApiUserDataFilterInAttributes( + are_relations_valid=True, + description="description_example", + maql="maql_example", + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + relationships=JsonApiUserDataFilterInRelationships( + user=JsonApiFilterViewInRelationshipsUser( + data=JsonApiUserToOneLinkage(None), + ), + user_group=JsonApiOrganizationOutRelationshipsBootstrapUserGroup( + data=JsonApiUserGroupToOneLinkage(None), + ), + ), + type="userDataFilter", + ), + ) # JsonApiUserDataFilterInDocument | + filter = "title==someString;description==someString;user.id==321;userGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "user,userGroup,facts,attributes,labels,metrics,datasets", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Put a User Data Filter + api_response = api_instance.update_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserDataFilterControllerApi->update_entity_user_data_filters: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put a User Data Filter + api_response = api_instance.update_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserDataFilterControllerApi->update_entity_user_data_filters: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_user_data_filter_in_document** | [**JsonApiUserDataFilterInDocument**](JsonApiUserDataFilterInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiUserDataFilterOutDocument**](JsonApiUserDataFilterOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/gooddata-api-client/docs/UserModelControllerApi.md b/gooddata-api-client/docs/UserModelControllerApi.md deleted file mode 100644 index 344b9f416..000000000 --- a/gooddata-api-client/docs/UserModelControllerApi.md +++ /dev/null @@ -1,739 +0,0 @@ -# gooddata_api_client.UserModelControllerApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_entity_api_tokens**](UserModelControllerApi.md#create_entity_api_tokens) | **POST** /api/v1/entities/users/{userId}/apiTokens | Post a new API token for the user -[**create_entity_user_settings**](UserModelControllerApi.md#create_entity_user_settings) | **POST** /api/v1/entities/users/{userId}/userSettings | Post new user settings for the user -[**delete_entity_api_tokens**](UserModelControllerApi.md#delete_entity_api_tokens) | **DELETE** /api/v1/entities/users/{userId}/apiTokens/{id} | Delete an API Token for a user -[**delete_entity_user_settings**](UserModelControllerApi.md#delete_entity_user_settings) | **DELETE** /api/v1/entities/users/{userId}/userSettings/{id} | Delete a setting for a user -[**get_all_entities_api_tokens**](UserModelControllerApi.md#get_all_entities_api_tokens) | **GET** /api/v1/entities/users/{userId}/apiTokens | List all api tokens for a user -[**get_all_entities_user_settings**](UserModelControllerApi.md#get_all_entities_user_settings) | **GET** /api/v1/entities/users/{userId}/userSettings | List all settings for a user -[**get_entity_api_tokens**](UserModelControllerApi.md#get_entity_api_tokens) | **GET** /api/v1/entities/users/{userId}/apiTokens/{id} | Get an API Token for a user -[**get_entity_user_settings**](UserModelControllerApi.md#get_entity_user_settings) | **GET** /api/v1/entities/users/{userId}/userSettings/{id} | Get a setting for a user -[**update_entity_user_settings**](UserModelControllerApi.md#update_entity_user_settings) | **PUT** /api/v1/entities/users/{userId}/userSettings/{id} | Put new user settings for the user - - -# **create_entity_api_tokens** -> JsonApiApiTokenOutDocument create_entity_api_tokens(user_id, json_api_api_token_in_document) - -Post a new API token for the user - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import user_model_controller_api -from gooddata_api_client.model.json_api_api_token_out_document import JsonApiApiTokenOutDocument -from gooddata_api_client.model.json_api_api_token_in_document import JsonApiApiTokenInDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = user_model_controller_api.UserModelControllerApi(api_client) - user_id = "userId_example" # str | - json_api_api_token_in_document = JsonApiApiTokenInDocument( - data=JsonApiApiTokenIn( - id="id1", - type="apiToken", - ), - ) # JsonApiApiTokenInDocument | - - # example passing only required values which don't have defaults set - try: - # Post a new API token for the user - 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 UserModelControllerApi->create_entity_api_tokens: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **json_api_api_token_in_document** | [**JsonApiApiTokenInDocument**](JsonApiApiTokenInDocument.md)| | - -### Return type - -[**JsonApiApiTokenOutDocument**](JsonApiApiTokenOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_entity_user_settings** -> JsonApiUserSettingOutDocument create_entity_user_settings(user_id, json_api_user_setting_in_document) - -Post new user settings for the user - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import user_model_controller_api -from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument -from gooddata_api_client.model.json_api_user_setting_in_document import JsonApiUserSettingInDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = user_model_controller_api.UserModelControllerApi(api_client) - user_id = "userId_example" # str | - json_api_user_setting_in_document = JsonApiUserSettingInDocument( - data=JsonApiUserSettingIn( - attributes=JsonApiOrganizationSettingInAttributes( - content={}, - type="TIMEZONE", - ), - id="id1", - type="userSetting", - ), - ) # JsonApiUserSettingInDocument | - - # example passing only required values which don't have defaults set - try: - # Post new user settings for the user - api_response = api_instance.create_entity_user_settings(user_id, json_api_user_setting_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling UserModelControllerApi->create_entity_user_settings: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **json_api_user_setting_in_document** | [**JsonApiUserSettingInDocument**](JsonApiUserSettingInDocument.md)| | - -### Return type - -[**JsonApiUserSettingOutDocument**](JsonApiUserSettingOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_entity_api_tokens** -> delete_entity_api_tokens(user_id, id) - -Delete an API Token for a user - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import user_model_controller_api -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = user_model_controller_api.UserModelControllerApi(api_client) - user_id = "userId_example" # str | - id = "/6bUUGjjNSwg0_bs" # str | - filter = "bearerToken==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete an API Token for a user - api_instance.delete_entity_api_tokens(user_id, id) - except gooddata_api_client.ApiException as e: - print("Exception when calling UserModelControllerApi->delete_entity_api_tokens: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Delete an API Token for a user - api_instance.delete_entity_api_tokens(user_id, id, filter=filter) - except gooddata_api_client.ApiException as e: - print("Exception when calling UserModelControllerApi->delete_entity_api_tokens: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Successfully deleted | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_entity_user_settings** -> delete_entity_user_settings(user_id, id) - -Delete a setting for a user - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import user_model_controller_api -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = user_model_controller_api.UserModelControllerApi(api_client) - user_id = "userId_example" # str | - id = "/6bUUGjjNSwg0_bs" # str | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete a setting for a user - api_instance.delete_entity_user_settings(user_id, id) - except gooddata_api_client.ApiException as e: - print("Exception when calling UserModelControllerApi->delete_entity_user_settings: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Delete a setting for a user - api_instance.delete_entity_user_settings(user_id, id, filter=filter) - except gooddata_api_client.ApiException as e: - print("Exception when calling UserModelControllerApi->delete_entity_user_settings: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Successfully deleted | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_entities_api_tokens** -> JsonApiApiTokenOutList get_all_entities_api_tokens(user_id) - -List all api tokens for a user - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import user_model_controller_api -from gooddata_api_client.model.json_api_api_token_out_list import JsonApiApiTokenOutList -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = user_model_controller_api.UserModelControllerApi(api_client) - user_id = "userId_example" # str | - filter = "bearerToken==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # List all api tokens for a user - api_response = api_instance.get_all_entities_api_tokens(user_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling UserModelControllerApi->get_all_entities_api_tokens: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # List all api tokens for a user - api_response = api_instance.get_all_entities_api_tokens(user_id, filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling UserModelControllerApi->get_all_entities_api_tokens: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiApiTokenOutList**](JsonApiApiTokenOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_entities_user_settings** -> JsonApiUserSettingOutList get_all_entities_user_settings(user_id) - -List all settings for a user - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import user_model_controller_api -from gooddata_api_client.model.json_api_user_setting_out_list import JsonApiUserSettingOutList -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = user_model_controller_api.UserModelControllerApi(api_client) - user_id = "userId_example" # str | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # List all settings for a user - api_response = api_instance.get_all_entities_user_settings(user_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling UserModelControllerApi->get_all_entities_user_settings: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # List all settings for a user - api_response = api_instance.get_all_entities_user_settings(user_id, filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling UserModelControllerApi->get_all_entities_user_settings: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiUserSettingOutList**](JsonApiUserSettingOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_entity_api_tokens** -> JsonApiApiTokenOutDocument get_entity_api_tokens(user_id, id) - -Get an API Token for a user - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import user_model_controller_api -from gooddata_api_client.model.json_api_api_token_out_document import JsonApiApiTokenOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = user_model_controller_api.UserModelControllerApi(api_client) - user_id = "userId_example" # str | - id = "/6bUUGjjNSwg0_bs" # str | - filter = "bearerToken==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Get an API Token for a user - api_response = api_instance.get_entity_api_tokens(user_id, id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling UserModelControllerApi->get_entity_api_tokens: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get an API Token for a user - api_response = api_instance.get_entity_api_tokens(user_id, id, filter=filter) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling UserModelControllerApi->get_entity_api_tokens: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -[**JsonApiApiTokenOutDocument**](JsonApiApiTokenOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_entity_user_settings** -> JsonApiUserSettingOutDocument get_entity_user_settings(user_id, id) - -Get a setting for a user - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import user_model_controller_api -from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = user_model_controller_api.UserModelControllerApi(api_client) - user_id = "userId_example" # str | - id = "/6bUUGjjNSwg0_bs" # str | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Get a setting for a user - api_response = api_instance.get_entity_user_settings(user_id, id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling UserModelControllerApi->get_entity_user_settings: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get a setting for a user - api_response = api_instance.get_entity_user_settings(user_id, id, filter=filter) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling UserModelControllerApi->get_entity_user_settings: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -[**JsonApiUserSettingOutDocument**](JsonApiUserSettingOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_entity_user_settings** -> JsonApiUserSettingOutDocument update_entity_user_settings(user_id, id, json_api_user_setting_in_document) - -Put new user settings for the user - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import user_model_controller_api -from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument -from gooddata_api_client.model.json_api_user_setting_in_document import JsonApiUserSettingInDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = user_model_controller_api.UserModelControllerApi(api_client) - user_id = "userId_example" # str | - id = "/6bUUGjjNSwg0_bs" # str | - json_api_user_setting_in_document = JsonApiUserSettingInDocument( - data=JsonApiUserSettingIn( - attributes=JsonApiOrganizationSettingInAttributes( - content={}, - type="TIMEZONE", - ), - id="id1", - type="userSetting", - ), - ) # JsonApiUserSettingInDocument | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put new user settings for the user - api_response = api_instance.update_entity_user_settings(user_id, id, json_api_user_setting_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling UserModelControllerApi->update_entity_user_settings: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Put new user settings for the user - api_response = api_instance.update_entity_user_settings(user_id, id, json_api_user_setting_in_document, filter=filter) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling UserModelControllerApi->update_entity_user_settings: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **id** | **str**| | - **json_api_user_setting_in_document** | [**JsonApiUserSettingInDocument**](JsonApiUserSettingInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -[**JsonApiUserSettingOutDocument**](JsonApiUserSettingOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/gooddata-api-client/docs/UserSettingControllerApi.md b/gooddata-api-client/docs/UserSettingControllerApi.md new file mode 100644 index 000000000..f490be11e --- /dev/null +++ b/gooddata-api-client/docs/UserSettingControllerApi.md @@ -0,0 +1,421 @@ +# gooddata_api_client.UserSettingControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_user_settings**](UserSettingControllerApi.md#create_entity_user_settings) | **POST** /api/v1/entities/users/{userId}/userSettings | Post new user settings for the user +[**delete_entity_user_settings**](UserSettingControllerApi.md#delete_entity_user_settings) | **DELETE** /api/v1/entities/users/{userId}/userSettings/{id} | Delete a setting for a user +[**get_all_entities_user_settings**](UserSettingControllerApi.md#get_all_entities_user_settings) | **GET** /api/v1/entities/users/{userId}/userSettings | List all settings for a user +[**get_entity_user_settings**](UserSettingControllerApi.md#get_entity_user_settings) | **GET** /api/v1/entities/users/{userId}/userSettings/{id} | Get a setting for a user +[**update_entity_user_settings**](UserSettingControllerApi.md#update_entity_user_settings) | **PUT** /api/v1/entities/users/{userId}/userSettings/{id} | Put new user settings for the user + + +# **create_entity_user_settings** +> JsonApiUserSettingOutDocument create_entity_user_settings(user_id, json_api_user_setting_in_document) + +Post new user settings for the user + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import user_setting_controller_api +from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.model.json_api_user_setting_in_document import JsonApiUserSettingInDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = user_setting_controller_api.UserSettingControllerApi(api_client) + user_id = "userId_example" # str | + json_api_user_setting_in_document = JsonApiUserSettingInDocument( + data=JsonApiUserSettingIn( + attributes=JsonApiOrganizationSettingInAttributes( + content={}, + type="TIMEZONE", + ), + id="id1", + type="userSetting", + ), + ) # JsonApiUserSettingInDocument | + + # example passing only required values which don't have defaults set + try: + # Post new user settings for the user + api_response = api_instance.create_entity_user_settings(user_id, json_api_user_setting_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserSettingControllerApi->create_entity_user_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_id** | **str**| | + **json_api_user_setting_in_document** | [**JsonApiUserSettingInDocument**](JsonApiUserSettingInDocument.md)| | + +### Return type + +[**JsonApiUserSettingOutDocument**](JsonApiUserSettingOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_entity_user_settings** +> delete_entity_user_settings(user_id, id) + +Delete a setting for a user + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import user_setting_controller_api +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = user_setting_controller_api.UserSettingControllerApi(api_client) + user_id = "userId_example" # str | + id = "/6bUUGjjNSwg0_bs" # str | + filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Delete a setting for a user + api_instance.delete_entity_user_settings(user_id, id) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserSettingControllerApi->delete_entity_user_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete a setting for a user + api_instance.delete_entity_user_settings(user_id, id, filter=filter) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserSettingControllerApi->delete_entity_user_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_id** | **str**| | + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successfully deleted | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_entities_user_settings** +> JsonApiUserSettingOutList get_all_entities_user_settings(user_id) + +List all settings for a user + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import user_setting_controller_api +from gooddata_api_client.model.json_api_user_setting_out_list import JsonApiUserSettingOutList +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = user_setting_controller_api.UserSettingControllerApi(api_client) + user_id = "userId_example" # str | + filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = [ + "metaInclude=page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # List all settings for a user + api_response = api_instance.get_all_entities_user_settings(user_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserSettingControllerApi->get_all_entities_user_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # List all settings for a user + api_response = api_instance.get_all_entities_user_settings(user_id, filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserSettingControllerApi->get_all_entities_user_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiUserSettingOutList**](JsonApiUserSettingOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_user_settings** +> JsonApiUserSettingOutDocument get_entity_user_settings(user_id, id) + +Get a setting for a user + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import user_setting_controller_api +from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = user_setting_controller_api.UserSettingControllerApi(api_client) + user_id = "userId_example" # str | + id = "/6bUUGjjNSwg0_bs" # str | + filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Get a setting for a user + api_response = api_instance.get_entity_user_settings(user_id, id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserSettingControllerApi->get_entity_user_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a setting for a user + api_response = api_instance.get_entity_user_settings(user_id, id, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserSettingControllerApi->get_entity_user_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_id** | **str**| | + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiUserSettingOutDocument**](JsonApiUserSettingOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_entity_user_settings** +> JsonApiUserSettingOutDocument update_entity_user_settings(user_id, id, json_api_user_setting_in_document) + +Put new user settings for the user + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import user_setting_controller_api +from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.model.json_api_user_setting_in_document import JsonApiUserSettingInDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = user_setting_controller_api.UserSettingControllerApi(api_client) + user_id = "userId_example" # str | + id = "/6bUUGjjNSwg0_bs" # str | + json_api_user_setting_in_document = JsonApiUserSettingInDocument( + data=JsonApiUserSettingIn( + attributes=JsonApiOrganizationSettingInAttributes( + content={}, + type="TIMEZONE", + ), + id="id1", + type="userSetting", + ), + ) # JsonApiUserSettingInDocument | + filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Put new user settings for the user + api_response = api_instance.update_entity_user_settings(user_id, id, json_api_user_setting_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserSettingControllerApi->update_entity_user_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put new user settings for the user + api_response = api_instance.update_entity_user_settings(user_id, id, json_api_user_setting_in_document, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserSettingControllerApi->update_entity_user_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_id** | **str**| | + **id** | **str**| | + **json_api_user_setting_in_document** | [**JsonApiUserSettingInDocument**](JsonApiUserSettingInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiUserSettingOutDocument**](JsonApiUserSettingOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/gooddata-api-client/docs/VisualizationObjectApi.md b/gooddata-api-client/docs/VisualizationObjectApi.md index c18722af1..d4213b6ab 100644 --- a/gooddata-api-client/docs/VisualizationObjectApi.md +++ b/gooddata-api-client/docs/VisualizationObjectApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description [**get_all_entities_visualization_objects**](VisualizationObjectApi.md#get_all_entities_visualization_objects) | **GET** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects | Get all Visualization Objects [**get_entity_visualization_objects**](VisualizationObjectApi.md#get_entity_visualization_objects) | **GET** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Get a Visualization Object [**patch_entity_visualization_objects**](VisualizationObjectApi.md#patch_entity_visualization_objects) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Patch a Visualization Object -[**search_entities_visualization_objects**](VisualizationObjectApi.md#search_entities_visualization_objects) | **POST** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/search | Search request for VisualizationObject +[**search_entities_visualization_objects**](VisualizationObjectApi.md#search_entities_visualization_objects) | **POST** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/search | The search endpoint (beta) [**update_entity_visualization_objects**](VisualizationObjectApi.md#update_entity_visualization_objects) | **PUT** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Put a Visualization Object @@ -475,7 +475,7 @@ No authorization required # **search_entities_visualization_objects** > JsonApiVisualizationObjectOutList search_entities_visualization_objects(workspace_id, entity_search_body) -Search request for VisualizationObject +The search endpoint (beta) ### Example @@ -523,7 +523,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Search request for VisualizationObject + # The search endpoint (beta) api_response = api_instance.search_entities_visualization_objects(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -532,7 +532,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Search request for VisualizationObject + # The search endpoint (beta) api_response = api_instance.search_entities_visualization_objects(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/VisualizationObjectControllerApi.md b/gooddata-api-client/docs/VisualizationObjectControllerApi.md new file mode 100644 index 000000000..cd9e75ea9 --- /dev/null +++ b/gooddata-api-client/docs/VisualizationObjectControllerApi.md @@ -0,0 +1,673 @@ +# gooddata_api_client.VisualizationObjectControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_visualization_objects**](VisualizationObjectControllerApi.md#create_entity_visualization_objects) | **POST** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects | Post Visualization Objects +[**delete_entity_visualization_objects**](VisualizationObjectControllerApi.md#delete_entity_visualization_objects) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Delete a Visualization Object +[**get_all_entities_visualization_objects**](VisualizationObjectControllerApi.md#get_all_entities_visualization_objects) | **GET** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects | Get all Visualization Objects +[**get_entity_visualization_objects**](VisualizationObjectControllerApi.md#get_entity_visualization_objects) | **GET** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Get a Visualization Object +[**patch_entity_visualization_objects**](VisualizationObjectControllerApi.md#patch_entity_visualization_objects) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Patch a Visualization Object +[**search_entities_visualization_objects**](VisualizationObjectControllerApi.md#search_entities_visualization_objects) | **POST** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/search | The search endpoint (beta) +[**update_entity_visualization_objects**](VisualizationObjectControllerApi.md#update_entity_visualization_objects) | **PUT** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Put a Visualization Object + + +# **create_entity_visualization_objects** +> JsonApiVisualizationObjectOutDocument create_entity_visualization_objects(workspace_id, json_api_visualization_object_post_optional_id_document) + +Post Visualization Objects + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import visualization_object_controller_api +from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.model.json_api_visualization_object_post_optional_id_document import JsonApiVisualizationObjectPostOptionalIdDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = visualization_object_controller_api.VisualizationObjectControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + json_api_visualization_object_post_optional_id_document = JsonApiVisualizationObjectPostOptionalIdDocument( + data=JsonApiVisualizationObjectPostOptionalId( + attributes=JsonApiVisualizationObjectInAttributes( + are_relations_valid=True, + content={}, + description="description_example", + is_hidden=True, + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="visualizationObject", + ), + ) # JsonApiVisualizationObjectPostOptionalIdDocument | + include = [ + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Visualization Objects + api_response = api_instance.create_entity_visualization_objects(workspace_id, json_api_visualization_object_post_optional_id_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling VisualizationObjectControllerApi->create_entity_visualization_objects: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Visualization Objects + api_response = api_instance.create_entity_visualization_objects(workspace_id, json_api_visualization_object_post_optional_id_document, include=include, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling VisualizationObjectControllerApi->create_entity_visualization_objects: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_visualization_object_post_optional_id_document** | [**JsonApiVisualizationObjectPostOptionalIdDocument**](JsonApiVisualizationObjectPostOptionalIdDocument.md)| | + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiVisualizationObjectOutDocument**](JsonApiVisualizationObjectOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_entity_visualization_objects** +> delete_entity_visualization_objects(workspace_id, object_id) + +Delete a Visualization Object + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import visualization_object_controller_api +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = visualization_object_controller_api.VisualizationObjectControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Delete a Visualization Object + api_instance.delete_entity_visualization_objects(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling VisualizationObjectControllerApi->delete_entity_visualization_objects: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete a Visualization Object + api_instance.delete_entity_visualization_objects(workspace_id, object_id, filter=filter) + except gooddata_api_client.ApiException as e: + print("Exception when calling VisualizationObjectControllerApi->delete_entity_visualization_objects: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successfully deleted | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_entities_visualization_objects** +> JsonApiVisualizationObjectOutList get_all_entities_visualization_objects(workspace_id) + +Get all Visualization Objects + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import visualization_object_controller_api +from gooddata_api_client.model.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = visualization_object_controller_api.VisualizationObjectControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get all Visualization Objects + api_response = api_instance.get_all_entities_visualization_objects(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling VisualizationObjectControllerApi->get_all_entities_visualization_objects: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Visualization Objects + api_response = api_instance.get_all_entities_visualization_objects(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling VisualizationObjectControllerApi->get_all_entities_visualization_objects: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiVisualizationObjectOutList**](JsonApiVisualizationObjectOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_visualization_objects** +> JsonApiVisualizationObjectOutDocument get_entity_visualization_objects(workspace_id, object_id) + +Get a Visualization Object + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import visualization_object_controller_api +from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = visualization_object_controller_api.VisualizationObjectControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a Visualization Object + api_response = api_instance.get_entity_visualization_objects(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling VisualizationObjectControllerApi->get_entity_visualization_objects: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Visualization Object + api_response = api_instance.get_entity_visualization_objects(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling VisualizationObjectControllerApi->get_entity_visualization_objects: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiVisualizationObjectOutDocument**](JsonApiVisualizationObjectOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **patch_entity_visualization_objects** +> JsonApiVisualizationObjectOutDocument patch_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_patch_document) + +Patch a Visualization Object + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import visualization_object_controller_api +from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.model.json_api_visualization_object_patch_document import JsonApiVisualizationObjectPatchDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = visualization_object_controller_api.VisualizationObjectControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_visualization_object_patch_document = JsonApiVisualizationObjectPatchDocument( + data=JsonApiVisualizationObjectPatch( + attributes=JsonApiVisualizationObjectPatchAttributes( + are_relations_valid=True, + content={}, + description="description_example", + is_hidden=True, + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="visualizationObject", + ), + ) # JsonApiVisualizationObjectPatchDocument | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Patch a Visualization Object + api_response = api_instance.patch_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling VisualizationObjectControllerApi->patch_entity_visualization_objects: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch a Visualization Object + api_response = api_instance.patch_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling VisualizationObjectControllerApi->patch_entity_visualization_objects: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_visualization_object_patch_document** | [**JsonApiVisualizationObjectPatchDocument**](JsonApiVisualizationObjectPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiVisualizationObjectOutDocument**](JsonApiVisualizationObjectOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **search_entities_visualization_objects** +> JsonApiVisualizationObjectOutList search_entities_visualization_objects(workspace_id, entity_search_body) + +The search endpoint (beta) + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import visualization_object_controller_api +from gooddata_api_client.model.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = visualization_object_controller_api.VisualizationObjectControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + entity_search_body = EntitySearchBody( + filter="filter_example", + include=[ + "include_example", + ], + meta_include=[ + "meta_include_example", + ], + page=EntitySearchPage( + index=0, + size=100, + ), + sort=[ + EntitySearchSort( + direction="ASC", + _property="_property_example", + ), + ], + ) # EntitySearchBody | Search request body with filter, pagination, and sorting options + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_visualization_objects(workspace_id, entity_search_body) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling VisualizationObjectControllerApi->search_entities_visualization_objects: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_visualization_objects(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling VisualizationObjectControllerApi->search_entities_visualization_objects: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + +### Return type + +[**JsonApiVisualizationObjectOutList**](JsonApiVisualizationObjectOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_entity_visualization_objects** +> JsonApiVisualizationObjectOutDocument update_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_in_document) + +Put a Visualization Object + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import visualization_object_controller_api +from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.model.json_api_visualization_object_in_document import JsonApiVisualizationObjectInDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = visualization_object_controller_api.VisualizationObjectControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_visualization_object_in_document = JsonApiVisualizationObjectInDocument( + data=JsonApiVisualizationObjectIn( + attributes=JsonApiVisualizationObjectInAttributes( + are_relations_valid=True, + content={}, + description="description_example", + is_hidden=True, + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="visualizationObject", + ), + ) # JsonApiVisualizationObjectInDocument | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Put a Visualization Object + api_response = api_instance.update_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling VisualizationObjectControllerApi->update_entity_visualization_objects: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put a Visualization Object + api_response = api_instance.update_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling VisualizationObjectControllerApi->update_entity_visualization_objects: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_visualization_object_in_document** | [**JsonApiVisualizationObjectInDocument**](JsonApiVisualizationObjectInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiVisualizationObjectOutDocument**](JsonApiVisualizationObjectOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/gooddata-api-client/docs/VisualizationSwitcherWidgetDescriptor.md b/gooddata-api-client/docs/VisualizationSwitcherWidgetDescriptor.md new file mode 100644 index 000000000..14833c12c --- /dev/null +++ b/gooddata-api-client/docs/VisualizationSwitcherWidgetDescriptor.md @@ -0,0 +1,18 @@ +# VisualizationSwitcherWidgetDescriptor + +Visualization switcher widget allowing users to toggle between multiple visualizations. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**active_visualization_id** | **str** | ID of the currently active visualization in the switcher. | +**title** | **str** | Widget title as displayed on the dashboard. | +**visualization_ids** | **[str]** | IDs of all visualizations available in the switcher. | +**widget_id** | **str** | Widget object ID. | +**widget_type** | **str** | | +**result_id** | **str** | Signed result ID for the currently active visualization's execution result. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/VisualizationSwitcherWidgetDescriptorAllOf.md b/gooddata-api-client/docs/VisualizationSwitcherWidgetDescriptorAllOf.md new file mode 100644 index 000000000..6a1a2e592 --- /dev/null +++ b/gooddata-api-client/docs/VisualizationSwitcherWidgetDescriptorAllOf.md @@ -0,0 +1,16 @@ +# VisualizationSwitcherWidgetDescriptorAllOf + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**active_visualization_id** | **str** | ID of the currently active visualization in the switcher. | [optional] +**result_id** | **str** | Signed result ID for the currently active visualization's execution result. | [optional] +**title** | **str** | Widget title as displayed on the dashboard. | [optional] +**visualization_ids** | **[str]** | IDs of all visualizations available in the switcher. | [optional] +**widget_id** | **str** | Widget object ID. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/WidgetDescriptor.md b/gooddata-api-client/docs/WidgetDescriptor.md new file mode 100644 index 000000000..2a88d122d --- /dev/null +++ b/gooddata-api-client/docs/WidgetDescriptor.md @@ -0,0 +1,15 @@ +# WidgetDescriptor + +Descriptor for a widget on the dashboard. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**title** | **str** | | +**widget_id** | **str** | | +**widget_type** | **str** | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/WorkspaceDataFilterControllerApi.md b/gooddata-api-client/docs/WorkspaceDataFilterControllerApi.md new file mode 100644 index 000000000..85f4a6655 --- /dev/null +++ b/gooddata-api-client/docs/WorkspaceDataFilterControllerApi.md @@ -0,0 +1,688 @@ +# gooddata_api_client.WorkspaceDataFilterControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_workspace_data_filters**](WorkspaceDataFilterControllerApi.md#create_entity_workspace_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters | Post Workspace Data Filters +[**delete_entity_workspace_data_filters**](WorkspaceDataFilterControllerApi.md#delete_entity_workspace_data_filters) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Delete a Workspace Data Filter +[**get_all_entities_workspace_data_filters**](WorkspaceDataFilterControllerApi.md#get_all_entities_workspace_data_filters) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters | Get all Workspace Data Filters +[**get_entity_workspace_data_filters**](WorkspaceDataFilterControllerApi.md#get_entity_workspace_data_filters) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Get a Workspace Data Filter +[**patch_entity_workspace_data_filters**](WorkspaceDataFilterControllerApi.md#patch_entity_workspace_data_filters) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Patch a Workspace Data Filter +[**search_entities_workspace_data_filters**](WorkspaceDataFilterControllerApi.md#search_entities_workspace_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/search | The search endpoint (beta) +[**update_entity_workspace_data_filters**](WorkspaceDataFilterControllerApi.md#update_entity_workspace_data_filters) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Put a Workspace Data Filter + + +# **create_entity_workspace_data_filters** +> JsonApiWorkspaceDataFilterOutDocument create_entity_workspace_data_filters(workspace_id, json_api_workspace_data_filter_in_document) + +Post Workspace Data Filters + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_data_filter_controller_api +from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.model.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = workspace_data_filter_controller_api.WorkspaceDataFilterControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + json_api_workspace_data_filter_in_document = JsonApiWorkspaceDataFilterInDocument( + data=JsonApiWorkspaceDataFilterIn( + attributes=JsonApiWorkspaceDataFilterInAttributes( + column_name="column_name_example", + description="description_example", + title="title_example", + ), + id="id1", + relationships=JsonApiWorkspaceDataFilterInRelationships( + filter_settings=JsonApiWorkspaceDataFilterInRelationshipsFilterSettings( + data=JsonApiWorkspaceDataFilterSettingToManyLinkage([ + JsonApiWorkspaceDataFilterSettingLinkage( + id="id_example", + type="workspaceDataFilterSetting", + ), + ]), + ), + ), + type="workspaceDataFilter", + ), + ) # JsonApiWorkspaceDataFilterInDocument | + include = [ + "filterSettings", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Workspace Data Filters + api_response = api_instance.create_entity_workspace_data_filters(workspace_id, json_api_workspace_data_filter_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceDataFilterControllerApi->create_entity_workspace_data_filters: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Workspace Data Filters + api_response = api_instance.create_entity_workspace_data_filters(workspace_id, json_api_workspace_data_filter_in_document, include=include, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceDataFilterControllerApi->create_entity_workspace_data_filters: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_workspace_data_filter_in_document** | [**JsonApiWorkspaceDataFilterInDocument**](JsonApiWorkspaceDataFilterInDocument.md)| | + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceDataFilterOutDocument**](JsonApiWorkspaceDataFilterOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_entity_workspace_data_filters** +> delete_entity_workspace_data_filters(workspace_id, object_id) + +Delete a Workspace Data Filter + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_data_filter_controller_api +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = workspace_data_filter_controller_api.WorkspaceDataFilterControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Delete a Workspace Data Filter + api_instance.delete_entity_workspace_data_filters(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceDataFilterControllerApi->delete_entity_workspace_data_filters: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete a Workspace Data Filter + api_instance.delete_entity_workspace_data_filters(workspace_id, object_id, filter=filter) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceDataFilterControllerApi->delete_entity_workspace_data_filters: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successfully deleted | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_entities_workspace_data_filters** +> JsonApiWorkspaceDataFilterOutList get_all_entities_workspace_data_filters(workspace_id) + +Get all Workspace Data Filters + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_data_filter_controller_api +from gooddata_api_client.model.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = workspace_data_filter_controller_api.WorkspaceDataFilterControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "filterSettings", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get all Workspace Data Filters + api_response = api_instance.get_all_entities_workspace_data_filters(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceDataFilterControllerApi->get_all_entities_workspace_data_filters: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Workspace Data Filters + api_response = api_instance.get_all_entities_workspace_data_filters(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceDataFilterControllerApi->get_all_entities_workspace_data_filters: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceDataFilterOutList**](JsonApiWorkspaceDataFilterOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_workspace_data_filters** +> JsonApiWorkspaceDataFilterOutDocument get_entity_workspace_data_filters(workspace_id, object_id) + +Get a Workspace Data Filter + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_data_filter_controller_api +from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = workspace_data_filter_controller_api.WorkspaceDataFilterControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "filterSettings", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a Workspace Data Filter + api_response = api_instance.get_entity_workspace_data_filters(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceDataFilterControllerApi->get_entity_workspace_data_filters: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Workspace Data Filter + api_response = api_instance.get_entity_workspace_data_filters(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceDataFilterControllerApi->get_entity_workspace_data_filters: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceDataFilterOutDocument**](JsonApiWorkspaceDataFilterOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **patch_entity_workspace_data_filters** +> JsonApiWorkspaceDataFilterOutDocument patch_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_patch_document) + +Patch a Workspace Data Filter + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_data_filter_controller_api +from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.model.json_api_workspace_data_filter_patch_document import JsonApiWorkspaceDataFilterPatchDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = workspace_data_filter_controller_api.WorkspaceDataFilterControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_workspace_data_filter_patch_document = JsonApiWorkspaceDataFilterPatchDocument( + data=JsonApiWorkspaceDataFilterPatch( + attributes=JsonApiWorkspaceDataFilterInAttributes( + column_name="column_name_example", + description="description_example", + title="title_example", + ), + id="id1", + relationships=JsonApiWorkspaceDataFilterInRelationships( + filter_settings=JsonApiWorkspaceDataFilterInRelationshipsFilterSettings( + data=JsonApiWorkspaceDataFilterSettingToManyLinkage([ + JsonApiWorkspaceDataFilterSettingLinkage( + id="id_example", + type="workspaceDataFilterSetting", + ), + ]), + ), + ), + type="workspaceDataFilter", + ), + ) # JsonApiWorkspaceDataFilterPatchDocument | + filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "filterSettings", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Patch a Workspace Data Filter + api_response = api_instance.patch_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceDataFilterControllerApi->patch_entity_workspace_data_filters: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch a Workspace Data Filter + api_response = api_instance.patch_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceDataFilterControllerApi->patch_entity_workspace_data_filters: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_data_filter_patch_document** | [**JsonApiWorkspaceDataFilterPatchDocument**](JsonApiWorkspaceDataFilterPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiWorkspaceDataFilterOutDocument**](JsonApiWorkspaceDataFilterOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **search_entities_workspace_data_filters** +> JsonApiWorkspaceDataFilterOutList search_entities_workspace_data_filters(workspace_id, entity_search_body) + +The search endpoint (beta) + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_data_filter_controller_api +from gooddata_api_client.model.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = workspace_data_filter_controller_api.WorkspaceDataFilterControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + entity_search_body = EntitySearchBody( + filter="filter_example", + include=[ + "include_example", + ], + meta_include=[ + "meta_include_example", + ], + page=EntitySearchPage( + index=0, + size=100, + ), + sort=[ + EntitySearchSort( + direction="ASC", + _property="_property_example", + ), + ], + ) # EntitySearchBody | Search request body with filter, pagination, and sorting options + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_workspace_data_filters(workspace_id, entity_search_body) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceDataFilterControllerApi->search_entities_workspace_data_filters: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_workspace_data_filters(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceDataFilterControllerApi->search_entities_workspace_data_filters: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + +### Return type + +[**JsonApiWorkspaceDataFilterOutList**](JsonApiWorkspaceDataFilterOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_entity_workspace_data_filters** +> JsonApiWorkspaceDataFilterOutDocument update_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_in_document) + +Put a Workspace Data Filter + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_data_filter_controller_api +from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.model.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = workspace_data_filter_controller_api.WorkspaceDataFilterControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_workspace_data_filter_in_document = JsonApiWorkspaceDataFilterInDocument( + data=JsonApiWorkspaceDataFilterIn( + attributes=JsonApiWorkspaceDataFilterInAttributes( + column_name="column_name_example", + description="description_example", + title="title_example", + ), + id="id1", + relationships=JsonApiWorkspaceDataFilterInRelationships( + filter_settings=JsonApiWorkspaceDataFilterInRelationshipsFilterSettings( + data=JsonApiWorkspaceDataFilterSettingToManyLinkage([ + JsonApiWorkspaceDataFilterSettingLinkage( + id="id_example", + type="workspaceDataFilterSetting", + ), + ]), + ), + ), + type="workspaceDataFilter", + ), + ) # JsonApiWorkspaceDataFilterInDocument | + filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "filterSettings", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Put a Workspace Data Filter + api_response = api_instance.update_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceDataFilterControllerApi->update_entity_workspace_data_filters: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put a Workspace Data Filter + api_response = api_instance.update_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceDataFilterControllerApi->update_entity_workspace_data_filters: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_data_filter_in_document** | [**JsonApiWorkspaceDataFilterInDocument**](JsonApiWorkspaceDataFilterInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiWorkspaceDataFilterOutDocument**](JsonApiWorkspaceDataFilterOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/gooddata-api-client/docs/WorkspaceDataFilterSettingControllerApi.md b/gooddata-api-client/docs/WorkspaceDataFilterSettingControllerApi.md new file mode 100644 index 000000000..d658c554a --- /dev/null +++ b/gooddata-api-client/docs/WorkspaceDataFilterSettingControllerApi.md @@ -0,0 +1,679 @@ +# gooddata_api_client.WorkspaceDataFilterSettingControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_workspace_data_filter_settings**](WorkspaceDataFilterSettingControllerApi.md#create_entity_workspace_data_filter_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings | Post Settings for Workspace Data Filters +[**delete_entity_workspace_data_filter_settings**](WorkspaceDataFilterSettingControllerApi.md#delete_entity_workspace_data_filter_settings) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Delete a Settings for Workspace Data Filter +[**get_all_entities_workspace_data_filter_settings**](WorkspaceDataFilterSettingControllerApi.md#get_all_entities_workspace_data_filter_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings | Get all Settings for Workspace Data Filters +[**get_entity_workspace_data_filter_settings**](WorkspaceDataFilterSettingControllerApi.md#get_entity_workspace_data_filter_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Get a Setting for Workspace Data Filter +[**patch_entity_workspace_data_filter_settings**](WorkspaceDataFilterSettingControllerApi.md#patch_entity_workspace_data_filter_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Patch a Settings for Workspace Data Filter +[**search_entities_workspace_data_filter_settings**](WorkspaceDataFilterSettingControllerApi.md#search_entities_workspace_data_filter_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/search | The search endpoint (beta) +[**update_entity_workspace_data_filter_settings**](WorkspaceDataFilterSettingControllerApi.md#update_entity_workspace_data_filter_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Put a Settings for Workspace Data Filter + + +# **create_entity_workspace_data_filter_settings** +> JsonApiWorkspaceDataFilterSettingOutDocument create_entity_workspace_data_filter_settings(workspace_id, json_api_workspace_data_filter_setting_in_document) + +Post Settings for Workspace Data Filters + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_data_filter_setting_controller_api +from gooddata_api_client.model.json_api_workspace_data_filter_setting_in_document import JsonApiWorkspaceDataFilterSettingInDocument +from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = workspace_data_filter_setting_controller_api.WorkspaceDataFilterSettingControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + json_api_workspace_data_filter_setting_in_document = JsonApiWorkspaceDataFilterSettingInDocument( + data=JsonApiWorkspaceDataFilterSettingIn( + attributes=JsonApiWorkspaceDataFilterSettingInAttributes( + description="description_example", + filter_values=[ + "filter_values_example", + ], + title="title_example", + ), + id="id1", + relationships=JsonApiWorkspaceDataFilterSettingInRelationships( + workspace_data_filter=JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter( + data=JsonApiWorkspaceDataFilterToOneLinkage(None), + ), + ), + type="workspaceDataFilterSetting", + ), + ) # JsonApiWorkspaceDataFilterSettingInDocument | + include = [ + "workspaceDataFilter", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Settings for Workspace Data Filters + api_response = api_instance.create_entity_workspace_data_filter_settings(workspace_id, json_api_workspace_data_filter_setting_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceDataFilterSettingControllerApi->create_entity_workspace_data_filter_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Settings for Workspace Data Filters + api_response = api_instance.create_entity_workspace_data_filter_settings(workspace_id, json_api_workspace_data_filter_setting_in_document, include=include, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceDataFilterSettingControllerApi->create_entity_workspace_data_filter_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_workspace_data_filter_setting_in_document** | [**JsonApiWorkspaceDataFilterSettingInDocument**](JsonApiWorkspaceDataFilterSettingInDocument.md)| | + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceDataFilterSettingOutDocument**](JsonApiWorkspaceDataFilterSettingOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_entity_workspace_data_filter_settings** +> delete_entity_workspace_data_filter_settings(workspace_id, object_id) + +Delete a Settings for Workspace Data Filter + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_data_filter_setting_controller_api +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = workspace_data_filter_setting_controller_api.WorkspaceDataFilterSettingControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;workspaceDataFilter.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Delete a Settings for Workspace Data Filter + api_instance.delete_entity_workspace_data_filter_settings(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceDataFilterSettingControllerApi->delete_entity_workspace_data_filter_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete a Settings for Workspace Data Filter + api_instance.delete_entity_workspace_data_filter_settings(workspace_id, object_id, filter=filter) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceDataFilterSettingControllerApi->delete_entity_workspace_data_filter_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successfully deleted | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_entities_workspace_data_filter_settings** +> JsonApiWorkspaceDataFilterSettingOutList get_all_entities_workspace_data_filter_settings(workspace_id) + +Get all Settings for Workspace Data Filters + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_data_filter_setting_controller_api +from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = workspace_data_filter_setting_controller_api.WorkspaceDataFilterSettingControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString;workspaceDataFilter.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "workspaceDataFilter", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get all Settings for Workspace Data Filters + api_response = api_instance.get_all_entities_workspace_data_filter_settings(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceDataFilterSettingControllerApi->get_all_entities_workspace_data_filter_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Settings for Workspace Data Filters + api_response = api_instance.get_all_entities_workspace_data_filter_settings(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceDataFilterSettingControllerApi->get_all_entities_workspace_data_filter_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceDataFilterSettingOutList**](JsonApiWorkspaceDataFilterSettingOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_workspace_data_filter_settings** +> JsonApiWorkspaceDataFilterSettingOutDocument get_entity_workspace_data_filter_settings(workspace_id, object_id) + +Get a Setting for Workspace Data Filter + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_data_filter_setting_controller_api +from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = workspace_data_filter_setting_controller_api.WorkspaceDataFilterSettingControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;workspaceDataFilter.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "workspaceDataFilter", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a Setting for Workspace Data Filter + api_response = api_instance.get_entity_workspace_data_filter_settings(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceDataFilterSettingControllerApi->get_entity_workspace_data_filter_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Setting for Workspace Data Filter + api_response = api_instance.get_entity_workspace_data_filter_settings(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceDataFilterSettingControllerApi->get_entity_workspace_data_filter_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceDataFilterSettingOutDocument**](JsonApiWorkspaceDataFilterSettingOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **patch_entity_workspace_data_filter_settings** +> JsonApiWorkspaceDataFilterSettingOutDocument patch_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_patch_document) + +Patch a Settings for Workspace Data Filter + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_data_filter_setting_controller_api +from gooddata_api_client.model.json_api_workspace_data_filter_setting_patch_document import JsonApiWorkspaceDataFilterSettingPatchDocument +from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = workspace_data_filter_setting_controller_api.WorkspaceDataFilterSettingControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_workspace_data_filter_setting_patch_document = JsonApiWorkspaceDataFilterSettingPatchDocument( + data=JsonApiWorkspaceDataFilterSettingPatch( + attributes=JsonApiWorkspaceDataFilterSettingInAttributes( + description="description_example", + filter_values=[ + "filter_values_example", + ], + title="title_example", + ), + id="id1", + relationships=JsonApiWorkspaceDataFilterSettingInRelationships( + workspace_data_filter=JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter( + data=JsonApiWorkspaceDataFilterToOneLinkage(None), + ), + ), + type="workspaceDataFilterSetting", + ), + ) # JsonApiWorkspaceDataFilterSettingPatchDocument | + filter = "title==someString;description==someString;workspaceDataFilter.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "workspaceDataFilter", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Patch a Settings for Workspace Data Filter + api_response = api_instance.patch_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceDataFilterSettingControllerApi->patch_entity_workspace_data_filter_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch a Settings for Workspace Data Filter + api_response = api_instance.patch_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceDataFilterSettingControllerApi->patch_entity_workspace_data_filter_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_data_filter_setting_patch_document** | [**JsonApiWorkspaceDataFilterSettingPatchDocument**](JsonApiWorkspaceDataFilterSettingPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiWorkspaceDataFilterSettingOutDocument**](JsonApiWorkspaceDataFilterSettingOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **search_entities_workspace_data_filter_settings** +> JsonApiWorkspaceDataFilterSettingOutList search_entities_workspace_data_filter_settings(workspace_id, entity_search_body) + +The search endpoint (beta) + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_data_filter_setting_controller_api +from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = workspace_data_filter_setting_controller_api.WorkspaceDataFilterSettingControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + entity_search_body = EntitySearchBody( + filter="filter_example", + include=[ + "include_example", + ], + meta_include=[ + "meta_include_example", + ], + page=EntitySearchPage( + index=0, + size=100, + ), + sort=[ + EntitySearchSort( + direction="ASC", + _property="_property_example", + ), + ], + ) # EntitySearchBody | Search request body with filter, pagination, and sorting options + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_workspace_data_filter_settings(workspace_id, entity_search_body) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceDataFilterSettingControllerApi->search_entities_workspace_data_filter_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_workspace_data_filter_settings(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceDataFilterSettingControllerApi->search_entities_workspace_data_filter_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + +### Return type + +[**JsonApiWorkspaceDataFilterSettingOutList**](JsonApiWorkspaceDataFilterSettingOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_entity_workspace_data_filter_settings** +> JsonApiWorkspaceDataFilterSettingOutDocument update_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_in_document) + +Put a Settings for Workspace Data Filter + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_data_filter_setting_controller_api +from gooddata_api_client.model.json_api_workspace_data_filter_setting_in_document import JsonApiWorkspaceDataFilterSettingInDocument +from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = workspace_data_filter_setting_controller_api.WorkspaceDataFilterSettingControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_workspace_data_filter_setting_in_document = JsonApiWorkspaceDataFilterSettingInDocument( + data=JsonApiWorkspaceDataFilterSettingIn( + attributes=JsonApiWorkspaceDataFilterSettingInAttributes( + description="description_example", + filter_values=[ + "filter_values_example", + ], + title="title_example", + ), + id="id1", + relationships=JsonApiWorkspaceDataFilterSettingInRelationships( + workspace_data_filter=JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter( + data=JsonApiWorkspaceDataFilterToOneLinkage(None), + ), + ), + type="workspaceDataFilterSetting", + ), + ) # JsonApiWorkspaceDataFilterSettingInDocument | + filter = "title==someString;description==someString;workspaceDataFilter.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "workspaceDataFilter", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Put a Settings for Workspace Data Filter + api_response = api_instance.update_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceDataFilterSettingControllerApi->update_entity_workspace_data_filter_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put a Settings for Workspace Data Filter + api_response = api_instance.update_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceDataFilterSettingControllerApi->update_entity_workspace_data_filter_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_data_filter_setting_in_document** | [**JsonApiWorkspaceDataFilterSettingInDocument**](JsonApiWorkspaceDataFilterSettingInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiWorkspaceDataFilterSettingOutDocument**](JsonApiWorkspaceDataFilterSettingOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/gooddata-api-client/docs/WorkspaceObjectControllerApi.md b/gooddata-api-client/docs/WorkspaceObjectControllerApi.md index e914a559c..76011f678 100644 --- a/gooddata-api-client/docs/WorkspaceObjectControllerApi.md +++ b/gooddata-api-client/docs/WorkspaceObjectControllerApi.md @@ -4,144 +4,30 @@ All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create_entity_analytical_dashboards**](WorkspaceObjectControllerApi.md#create_entity_analytical_dashboards) | **POST** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards | Post Dashboards -[**create_entity_attribute_hierarchies**](WorkspaceObjectControllerApi.md#create_entity_attribute_hierarchies) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies | Post Attribute Hierarchies -[**create_entity_automations**](WorkspaceObjectControllerApi.md#create_entity_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations | Post Automations -[**create_entity_custom_application_settings**](WorkspaceObjectControllerApi.md#create_entity_custom_application_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings | Post Custom Application Settings -[**create_entity_dashboard_plugins**](WorkspaceObjectControllerApi.md#create_entity_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins | Post Plugins -[**create_entity_export_definitions**](WorkspaceObjectControllerApi.md#create_entity_export_definitions) | **POST** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions | Post Export Definitions -[**create_entity_filter_contexts**](WorkspaceObjectControllerApi.md#create_entity_filter_contexts) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterContexts | Post Filter Context -[**create_entity_filter_views**](WorkspaceObjectControllerApi.md#create_entity_filter_views) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterViews | Post Filter views [**create_entity_knowledge_recommendations**](WorkspaceObjectControllerApi.md#create_entity_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations | [**create_entity_memory_items**](WorkspaceObjectControllerApi.md#create_entity_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems | -[**create_entity_metrics**](WorkspaceObjectControllerApi.md#create_entity_metrics) | **POST** /api/v1/entities/workspaces/{workspaceId}/metrics | Post Metrics -[**create_entity_user_data_filters**](WorkspaceObjectControllerApi.md#create_entity_user_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/userDataFilters | Post User Data Filters -[**create_entity_visualization_objects**](WorkspaceObjectControllerApi.md#create_entity_visualization_objects) | **POST** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects | Post Visualization Objects -[**create_entity_workspace_data_filter_settings**](WorkspaceObjectControllerApi.md#create_entity_workspace_data_filter_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings | Post Settings for Workspace Data Filters -[**create_entity_workspace_data_filters**](WorkspaceObjectControllerApi.md#create_entity_workspace_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters | Post Workspace Data Filters -[**create_entity_workspace_settings**](WorkspaceObjectControllerApi.md#create_entity_workspace_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings | Post Settings for Workspaces -[**delete_entity_analytical_dashboards**](WorkspaceObjectControllerApi.md#delete_entity_analytical_dashboards) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Delete a Dashboard -[**delete_entity_attribute_hierarchies**](WorkspaceObjectControllerApi.md#delete_entity_attribute_hierarchies) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Delete an Attribute Hierarchy -[**delete_entity_automations**](WorkspaceObjectControllerApi.md#delete_entity_automations) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Delete an Automation -[**delete_entity_custom_application_settings**](WorkspaceObjectControllerApi.md#delete_entity_custom_application_settings) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Delete a Custom Application Setting -[**delete_entity_dashboard_plugins**](WorkspaceObjectControllerApi.md#delete_entity_dashboard_plugins) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Delete a Plugin -[**delete_entity_export_definitions**](WorkspaceObjectControllerApi.md#delete_entity_export_definitions) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Delete an Export Definition -[**delete_entity_filter_contexts**](WorkspaceObjectControllerApi.md#delete_entity_filter_contexts) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Delete a Filter Context -[**delete_entity_filter_views**](WorkspaceObjectControllerApi.md#delete_entity_filter_views) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Delete Filter view [**delete_entity_knowledge_recommendations**](WorkspaceObjectControllerApi.md#delete_entity_knowledge_recommendations) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | [**delete_entity_memory_items**](WorkspaceObjectControllerApi.md#delete_entity_memory_items) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | -[**delete_entity_metrics**](WorkspaceObjectControllerApi.md#delete_entity_metrics) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Delete a Metric -[**delete_entity_user_data_filters**](WorkspaceObjectControllerApi.md#delete_entity_user_data_filters) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Delete a User Data Filter -[**delete_entity_visualization_objects**](WorkspaceObjectControllerApi.md#delete_entity_visualization_objects) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Delete a Visualization Object -[**delete_entity_workspace_data_filter_settings**](WorkspaceObjectControllerApi.md#delete_entity_workspace_data_filter_settings) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Delete a Settings for Workspace Data Filter -[**delete_entity_workspace_data_filters**](WorkspaceObjectControllerApi.md#delete_entity_workspace_data_filters) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Delete a Workspace Data Filter -[**delete_entity_workspace_settings**](WorkspaceObjectControllerApi.md#delete_entity_workspace_settings) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Delete a Setting for Workspace [**get_all_entities_aggregated_facts**](WorkspaceObjectControllerApi.md#get_all_entities_aggregated_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/aggregatedFacts | -[**get_all_entities_analytical_dashboards**](WorkspaceObjectControllerApi.md#get_all_entities_analytical_dashboards) | **GET** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards | Get all Dashboards -[**get_all_entities_attribute_hierarchies**](WorkspaceObjectControllerApi.md#get_all_entities_attribute_hierarchies) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies | Get all Attribute Hierarchies -[**get_all_entities_attributes**](WorkspaceObjectControllerApi.md#get_all_entities_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributes | Get all Attributes -[**get_all_entities_automations**](WorkspaceObjectControllerApi.md#get_all_entities_automations) | **GET** /api/v1/entities/workspaces/{workspaceId}/automations | Get all Automations -[**get_all_entities_custom_application_settings**](WorkspaceObjectControllerApi.md#get_all_entities_custom_application_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings | Get all Custom Application Settings -[**get_all_entities_dashboard_plugins**](WorkspaceObjectControllerApi.md#get_all_entities_dashboard_plugins) | **GET** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins | Get all Plugins -[**get_all_entities_datasets**](WorkspaceObjectControllerApi.md#get_all_entities_datasets) | **GET** /api/v1/entities/workspaces/{workspaceId}/datasets | Get all Datasets -[**get_all_entities_export_definitions**](WorkspaceObjectControllerApi.md#get_all_entities_export_definitions) | **GET** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions | Get all Export Definitions -[**get_all_entities_facts**](WorkspaceObjectControllerApi.md#get_all_entities_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/facts | Get all Facts -[**get_all_entities_filter_contexts**](WorkspaceObjectControllerApi.md#get_all_entities_filter_contexts) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterContexts | Get all Filter Context -[**get_all_entities_filter_views**](WorkspaceObjectControllerApi.md#get_all_entities_filter_views) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterViews | Get all Filter views [**get_all_entities_knowledge_recommendations**](WorkspaceObjectControllerApi.md#get_all_entities_knowledge_recommendations) | **GET** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations | -[**get_all_entities_labels**](WorkspaceObjectControllerApi.md#get_all_entities_labels) | **GET** /api/v1/entities/workspaces/{workspaceId}/labels | Get all Labels [**get_all_entities_memory_items**](WorkspaceObjectControllerApi.md#get_all_entities_memory_items) | **GET** /api/v1/entities/workspaces/{workspaceId}/memoryItems | -[**get_all_entities_metrics**](WorkspaceObjectControllerApi.md#get_all_entities_metrics) | **GET** /api/v1/entities/workspaces/{workspaceId}/metrics | Get all Metrics -[**get_all_entities_user_data_filters**](WorkspaceObjectControllerApi.md#get_all_entities_user_data_filters) | **GET** /api/v1/entities/workspaces/{workspaceId}/userDataFilters | Get all User Data Filters -[**get_all_entities_visualization_objects**](WorkspaceObjectControllerApi.md#get_all_entities_visualization_objects) | **GET** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects | Get all Visualization Objects -[**get_all_entities_workspace_data_filter_settings**](WorkspaceObjectControllerApi.md#get_all_entities_workspace_data_filter_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings | Get all Settings for Workspace Data Filters -[**get_all_entities_workspace_data_filters**](WorkspaceObjectControllerApi.md#get_all_entities_workspace_data_filters) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters | Get all Workspace Data Filters -[**get_all_entities_workspace_settings**](WorkspaceObjectControllerApi.md#get_all_entities_workspace_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings | Get all Setting for Workspaces [**get_entity_aggregated_facts**](WorkspaceObjectControllerApi.md#get_entity_aggregated_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/{objectId} | -[**get_entity_analytical_dashboards**](WorkspaceObjectControllerApi.md#get_entity_analytical_dashboards) | **GET** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Get a Dashboard -[**get_entity_attribute_hierarchies**](WorkspaceObjectControllerApi.md#get_entity_attribute_hierarchies) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Get an Attribute Hierarchy -[**get_entity_attributes**](WorkspaceObjectControllerApi.md#get_entity_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId} | Get an Attribute -[**get_entity_automations**](WorkspaceObjectControllerApi.md#get_entity_automations) | **GET** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Get an Automation -[**get_entity_custom_application_settings**](WorkspaceObjectControllerApi.md#get_entity_custom_application_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Get a Custom Application Setting -[**get_entity_dashboard_plugins**](WorkspaceObjectControllerApi.md#get_entity_dashboard_plugins) | **GET** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Get a Plugin -[**get_entity_datasets**](WorkspaceObjectControllerApi.md#get_entity_datasets) | **GET** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Get a Dataset -[**get_entity_export_definitions**](WorkspaceObjectControllerApi.md#get_entity_export_definitions) | **GET** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Get an Export Definition -[**get_entity_facts**](WorkspaceObjectControllerApi.md#get_entity_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/facts/{objectId} | Get a Fact -[**get_entity_filter_contexts**](WorkspaceObjectControllerApi.md#get_entity_filter_contexts) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Get a Filter Context -[**get_entity_filter_views**](WorkspaceObjectControllerApi.md#get_entity_filter_views) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Get Filter view [**get_entity_knowledge_recommendations**](WorkspaceObjectControllerApi.md#get_entity_knowledge_recommendations) | **GET** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | -[**get_entity_labels**](WorkspaceObjectControllerApi.md#get_entity_labels) | **GET** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Get a Label [**get_entity_memory_items**](WorkspaceObjectControllerApi.md#get_entity_memory_items) | **GET** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | -[**get_entity_metrics**](WorkspaceObjectControllerApi.md#get_entity_metrics) | **GET** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Get a Metric -[**get_entity_user_data_filters**](WorkspaceObjectControllerApi.md#get_entity_user_data_filters) | **GET** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Get a User Data Filter -[**get_entity_visualization_objects**](WorkspaceObjectControllerApi.md#get_entity_visualization_objects) | **GET** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Get a Visualization Object -[**get_entity_workspace_data_filter_settings**](WorkspaceObjectControllerApi.md#get_entity_workspace_data_filter_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Get a Setting for Workspace Data Filter -[**get_entity_workspace_data_filters**](WorkspaceObjectControllerApi.md#get_entity_workspace_data_filters) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Get a Workspace Data Filter -[**get_entity_workspace_settings**](WorkspaceObjectControllerApi.md#get_entity_workspace_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Get a Setting for Workspace -[**patch_entity_analytical_dashboards**](WorkspaceObjectControllerApi.md#patch_entity_analytical_dashboards) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Patch a Dashboard -[**patch_entity_attribute_hierarchies**](WorkspaceObjectControllerApi.md#patch_entity_attribute_hierarchies) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Patch an Attribute Hierarchy -[**patch_entity_attributes**](WorkspaceObjectControllerApi.md#patch_entity_attributes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId} | Patch an Attribute (beta) -[**patch_entity_automations**](WorkspaceObjectControllerApi.md#patch_entity_automations) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Patch an Automation -[**patch_entity_custom_application_settings**](WorkspaceObjectControllerApi.md#patch_entity_custom_application_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Patch a Custom Application Setting -[**patch_entity_dashboard_plugins**](WorkspaceObjectControllerApi.md#patch_entity_dashboard_plugins) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Patch a Plugin -[**patch_entity_datasets**](WorkspaceObjectControllerApi.md#patch_entity_datasets) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Patch a Dataset (beta) -[**patch_entity_export_definitions**](WorkspaceObjectControllerApi.md#patch_entity_export_definitions) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Patch an Export Definition -[**patch_entity_facts**](WorkspaceObjectControllerApi.md#patch_entity_facts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/facts/{objectId} | Patch a Fact (beta) -[**patch_entity_filter_contexts**](WorkspaceObjectControllerApi.md#patch_entity_filter_contexts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Patch a Filter Context -[**patch_entity_filter_views**](WorkspaceObjectControllerApi.md#patch_entity_filter_views) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Patch Filter view [**patch_entity_knowledge_recommendations**](WorkspaceObjectControllerApi.md#patch_entity_knowledge_recommendations) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | -[**patch_entity_labels**](WorkspaceObjectControllerApi.md#patch_entity_labels) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Patch a Label (beta) [**patch_entity_memory_items**](WorkspaceObjectControllerApi.md#patch_entity_memory_items) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | -[**patch_entity_metrics**](WorkspaceObjectControllerApi.md#patch_entity_metrics) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Patch a Metric -[**patch_entity_user_data_filters**](WorkspaceObjectControllerApi.md#patch_entity_user_data_filters) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Patch a User Data Filter -[**patch_entity_visualization_objects**](WorkspaceObjectControllerApi.md#patch_entity_visualization_objects) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Patch a Visualization Object -[**patch_entity_workspace_data_filter_settings**](WorkspaceObjectControllerApi.md#patch_entity_workspace_data_filter_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Patch a Settings for Workspace Data Filter -[**patch_entity_workspace_data_filters**](WorkspaceObjectControllerApi.md#patch_entity_workspace_data_filters) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Patch a Workspace Data Filter -[**patch_entity_workspace_settings**](WorkspaceObjectControllerApi.md#patch_entity_workspace_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Patch a Setting for Workspace [**search_entities_aggregated_facts**](WorkspaceObjectControllerApi.md#search_entities_aggregated_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/search | Search request for AggregatedFact -[**search_entities_analytical_dashboards**](WorkspaceObjectControllerApi.md#search_entities_analytical_dashboards) | **POST** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search | Search request for AnalyticalDashboard -[**search_entities_attribute_hierarchies**](WorkspaceObjectControllerApi.md#search_entities_attribute_hierarchies) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search | Search request for AttributeHierarchy -[**search_entities_attributes**](WorkspaceObjectControllerApi.md#search_entities_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributes/search | Search request for Attribute [**search_entities_automation_results**](WorkspaceObjectControllerApi.md#search_entities_automation_results) | **POST** /api/v1/entities/workspaces/{workspaceId}/automationResults/search | Search request for AutomationResult -[**search_entities_automations**](WorkspaceObjectControllerApi.md#search_entities_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations/search | Search request for Automation -[**search_entities_custom_application_settings**](WorkspaceObjectControllerApi.md#search_entities_custom_application_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search | Search request for CustomApplicationSetting -[**search_entities_dashboard_plugins**](WorkspaceObjectControllerApi.md#search_entities_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search | Search request for DashboardPlugin -[**search_entities_datasets**](WorkspaceObjectControllerApi.md#search_entities_datasets) | **POST** /api/v1/entities/workspaces/{workspaceId}/datasets/search | Search request for Dataset -[**search_entities_export_definitions**](WorkspaceObjectControllerApi.md#search_entities_export_definitions) | **POST** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/search | Search request for ExportDefinition -[**search_entities_facts**](WorkspaceObjectControllerApi.md#search_entities_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/facts/search | Search request for Fact -[**search_entities_filter_contexts**](WorkspaceObjectControllerApi.md#search_entities_filter_contexts) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterContexts/search | Search request for FilterContext -[**search_entities_filter_views**](WorkspaceObjectControllerApi.md#search_entities_filter_views) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterViews/search | Search request for FilterView -[**search_entities_knowledge_recommendations**](WorkspaceObjectControllerApi.md#search_entities_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search | -[**search_entities_labels**](WorkspaceObjectControllerApi.md#search_entities_labels) | **POST** /api/v1/entities/workspaces/{workspaceId}/labels/search | Search request for Label +[**search_entities_knowledge_recommendations**](WorkspaceObjectControllerApi.md#search_entities_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search | The search endpoint (beta) [**search_entities_memory_items**](WorkspaceObjectControllerApi.md#search_entities_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems/search | Search request for MemoryItem -[**search_entities_metrics**](WorkspaceObjectControllerApi.md#search_entities_metrics) | **POST** /api/v1/entities/workspaces/{workspaceId}/metrics/search | Search request for Metric -[**search_entities_user_data_filters**](WorkspaceObjectControllerApi.md#search_entities_user_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/search | Search request for UserDataFilter -[**search_entities_visualization_objects**](WorkspaceObjectControllerApi.md#search_entities_visualization_objects) | **POST** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/search | Search request for VisualizationObject -[**search_entities_workspace_data_filter_settings**](WorkspaceObjectControllerApi.md#search_entities_workspace_data_filter_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/search | Search request for WorkspaceDataFilterSetting -[**search_entities_workspace_data_filters**](WorkspaceObjectControllerApi.md#search_entities_workspace_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/search | Search request for WorkspaceDataFilter -[**search_entities_workspace_settings**](WorkspaceObjectControllerApi.md#search_entities_workspace_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/search | -[**update_entity_analytical_dashboards**](WorkspaceObjectControllerApi.md#update_entity_analytical_dashboards) | **PUT** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Put Dashboards -[**update_entity_attribute_hierarchies**](WorkspaceObjectControllerApi.md#update_entity_attribute_hierarchies) | **PUT** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Put an Attribute Hierarchy -[**update_entity_automations**](WorkspaceObjectControllerApi.md#update_entity_automations) | **PUT** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Put an Automation -[**update_entity_custom_application_settings**](WorkspaceObjectControllerApi.md#update_entity_custom_application_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Put a Custom Application Setting -[**update_entity_dashboard_plugins**](WorkspaceObjectControllerApi.md#update_entity_dashboard_plugins) | **PUT** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Put a Plugin -[**update_entity_export_definitions**](WorkspaceObjectControllerApi.md#update_entity_export_definitions) | **PUT** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Put an Export Definition -[**update_entity_filter_contexts**](WorkspaceObjectControllerApi.md#update_entity_filter_contexts) | **PUT** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Put a Filter Context -[**update_entity_filter_views**](WorkspaceObjectControllerApi.md#update_entity_filter_views) | **PUT** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Put Filter views [**update_entity_knowledge_recommendations**](WorkspaceObjectControllerApi.md#update_entity_knowledge_recommendations) | **PUT** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | [**update_entity_memory_items**](WorkspaceObjectControllerApi.md#update_entity_memory_items) | **PUT** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | -[**update_entity_metrics**](WorkspaceObjectControllerApi.md#update_entity_metrics) | **PUT** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Put a Metric -[**update_entity_user_data_filters**](WorkspaceObjectControllerApi.md#update_entity_user_data_filters) | **PUT** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Put a User Data Filter -[**update_entity_visualization_objects**](WorkspaceObjectControllerApi.md#update_entity_visualization_objects) | **PUT** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Put a Visualization Object -[**update_entity_workspace_data_filter_settings**](WorkspaceObjectControllerApi.md#update_entity_workspace_data_filter_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Put a Settings for Workspace Data Filter -[**update_entity_workspace_data_filters**](WorkspaceObjectControllerApi.md#update_entity_workspace_data_filters) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Put a Workspace Data Filter -[**update_entity_workspace_settings**](WorkspaceObjectControllerApi.md#update_entity_workspace_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Put a Setting for a Workspace -# **create_entity_analytical_dashboards** -> JsonApiAnalyticalDashboardOutDocument create_entity_analytical_dashboards(workspace_id, json_api_analytical_dashboard_post_optional_id_document) +# **create_entity_knowledge_recommendations** +> JsonApiKnowledgeRecommendationOutDocument create_entity_knowledge_recommendations(workspace_id, json_api_knowledge_recommendation_post_optional_id_document) + -Post Dashboards ### Example @@ -150,8 +36,8 @@ Post Dashboards import time import gooddata_api_client from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_analytical_dashboard_post_optional_id_document import JsonApiAnalyticalDashboardPostOptionalIdDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.model.json_api_knowledge_recommendation_out_document import JsonApiKnowledgeRecommendationOutDocument +from gooddata_api_client.model.json_api_knowledge_recommendation_post_optional_id_document import JsonApiKnowledgeRecommendationPostOptionalIdDocument 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. @@ -165,45 +51,62 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) workspace_id = "workspaceId_example" # str | - json_api_analytical_dashboard_post_optional_id_document = JsonApiAnalyticalDashboardPostOptionalIdDocument( - data=JsonApiAnalyticalDashboardPostOptionalId( - attributes=JsonApiAnalyticalDashboardInAttributes( + json_api_knowledge_recommendation_post_optional_id_document = JsonApiKnowledgeRecommendationPostOptionalIdDocument( + data=JsonApiKnowledgeRecommendationPostOptionalId( + attributes=JsonApiKnowledgeRecommendationInAttributes( + analytical_dashboard_title="Portfolio Health Insights", + analyzed_period="2023-07", + analyzed_value=None, are_relations_valid=True, - content={}, + comparison_type="MONTH", + confidence=None, description="description_example", - summary="summary_example", + direction="DECREASED", + metric_title="Revenue", + recommendations={}, + reference_period="2023-06", + reference_value=None, + source_count=2, tags=[ "tags_example", ], title="title_example", + widget_id="widget-123", + widget_name="Revenue Trend", ), id="id1", - type="analyticalDashboard", + relationships=JsonApiKnowledgeRecommendationInRelationships( + analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + metric=JsonApiKnowledgeRecommendationInRelationshipsMetric( + data=JsonApiMetricToOneLinkage(None), + ), + ), + type="knowledgeRecommendation", ), - ) # JsonApiAnalyticalDashboardPostOptionalIdDocument | + ) # JsonApiKnowledgeRecommendationPostOptionalIdDocument | include = [ - "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + "metric,analyticalDashboard", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) meta_include = [ - "metaInclude=permissions,origin,accessInfo,all", + "metaInclude=origin,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Post Dashboards - api_response = api_instance.create_entity_analytical_dashboards(workspace_id, json_api_analytical_dashboard_post_optional_id_document) + api_response = api_instance.create_entity_knowledge_recommendations(workspace_id, json_api_knowledge_recommendation_post_optional_id_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_analytical_dashboards: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->create_entity_knowledge_recommendations: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Post Dashboards - api_response = api_instance.create_entity_analytical_dashboards(workspace_id, json_api_analytical_dashboard_post_optional_id_document, include=include, meta_include=meta_include) + api_response = api_instance.create_entity_knowledge_recommendations(workspace_id, json_api_knowledge_recommendation_post_optional_id_document, include=include, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_analytical_dashboards: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->create_entity_knowledge_recommendations: %s\n" % e) ``` @@ -212,13 +115,13 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | - **json_api_analytical_dashboard_post_optional_id_document** | [**JsonApiAnalyticalDashboardPostOptionalIdDocument**](JsonApiAnalyticalDashboardPostOptionalIdDocument.md)| | + **json_api_knowledge_recommendation_post_optional_id_document** | [**JsonApiKnowledgeRecommendationPostOptionalIdDocument**](JsonApiKnowledgeRecommendationPostOptionalIdDocument.md)| | **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -[**JsonApiAnalyticalDashboardOutDocument**](JsonApiAnalyticalDashboardOutDocument.md) +[**JsonApiKnowledgeRecommendationOutDocument**](JsonApiKnowledgeRecommendationOutDocument.md) ### Authorization @@ -238,10 +141,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **create_entity_attribute_hierarchies** -> JsonApiAttributeHierarchyOutDocument create_entity_attribute_hierarchies(workspace_id, json_api_attribute_hierarchy_in_document) +# **create_entity_memory_items** +> JsonApiMemoryItemOutDocument create_entity_memory_items(workspace_id, json_api_memory_item_post_optional_id_document) + -Post Attribute Hierarchies ### Example @@ -250,8 +153,8 @@ Post Attribute Hierarchies import time import gooddata_api_client from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_attribute_hierarchy_in_document import JsonApiAttributeHierarchyInDocument -from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +from gooddata_api_client.model.json_api_memory_item_post_optional_id_document import JsonApiMemoryItemPostOptionalIdDocument +from gooddata_api_client.model.json_api_memory_item_out_document import JsonApiMemoryItemOutDocument 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. @@ -265,23 +168,28 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) workspace_id = "workspaceId_example" # str | - json_api_attribute_hierarchy_in_document = JsonApiAttributeHierarchyInDocument( - data=JsonApiAttributeHierarchyIn( - attributes=JsonApiAttributeHierarchyInAttributes( + json_api_memory_item_post_optional_id_document = JsonApiMemoryItemPostOptionalIdDocument( + data=JsonApiMemoryItemPostOptionalId( + attributes=JsonApiMemoryItemInAttributes( are_relations_valid=True, - content={}, description="description_example", + instruction="instruction_example", + is_disabled=True, + keywords=[ + "keywords_example", + ], + strategy="ALWAYS", tags=[ "tags_example", ], title="title_example", ), id="id1", - type="attributeHierarchy", + type="memoryItem", ), - ) # JsonApiAttributeHierarchyInDocument | + ) # JsonApiMemoryItemPostOptionalIdDocument | include = [ - "createdBy,modifiedBy,attributes", + "createdBy,modifiedBy", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) meta_include = [ "metaInclude=origin,all", @@ -289,20 +197,18 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Post Attribute Hierarchies - api_response = api_instance.create_entity_attribute_hierarchies(workspace_id, json_api_attribute_hierarchy_in_document) + api_response = api_instance.create_entity_memory_items(workspace_id, json_api_memory_item_post_optional_id_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_attribute_hierarchies: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->create_entity_memory_items: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Post Attribute Hierarchies - api_response = api_instance.create_entity_attribute_hierarchies(workspace_id, json_api_attribute_hierarchy_in_document, include=include, meta_include=meta_include) + api_response = api_instance.create_entity_memory_items(workspace_id, json_api_memory_item_post_optional_id_document, include=include, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_attribute_hierarchies: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->create_entity_memory_items: %s\n" % e) ``` @@ -311,13 +217,13 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | - **json_api_attribute_hierarchy_in_document** | [**JsonApiAttributeHierarchyInDocument**](JsonApiAttributeHierarchyInDocument.md)| | + **json_api_memory_item_post_optional_id_document** | [**JsonApiMemoryItemPostOptionalIdDocument**](JsonApiMemoryItemPostOptionalIdDocument.md)| | **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -[**JsonApiAttributeHierarchyOutDocument**](JsonApiAttributeHierarchyOutDocument.md) +[**JsonApiMemoryItemOutDocument**](JsonApiMemoryItemOutDocument.md) ### Authorization @@ -337,10 +243,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **create_entity_automations** -> JsonApiAutomationOutDocument create_entity_automations(workspace_id, json_api_automation_in_document) +# **delete_entity_knowledge_recommendations** +> delete_entity_knowledge_recommendations(workspace_id, object_id) + -Post Automations ### Example @@ -349,8 +255,6 @@ Post Automations import time import gooddata_api_client from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_automation_in_document import JsonApiAutomationInDocument -from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument 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. @@ -364,300 +268,21 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) workspace_id = "workspaceId_example" # str | - json_api_automation_in_document = JsonApiAutomationInDocument( - data=JsonApiAutomationIn( - attributes=JsonApiAutomationInAttributes( - alert=JsonApiAutomationInAttributesAlert( - condition=AlertCondition(), - execution=AlertAfm( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - interval="DAY", - trigger="ALWAYS", - ), - are_relations_valid=True, - dashboard_tabular_exports=[ - JsonApiAutomationInAttributesDashboardTabularExportsInner( - request_payload=DashboardTabularExportRequestV2( - dashboard_filters_override=[ - DashboardFilter(), - ], - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - dashboard_tabs_filters_overrides={ - "key": [ - DashboardFilter(), - ], - }, - file_name="result", - format="XLSX", - settings=DashboardExportSettings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - ), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - description="description_example", - details={}, - evaluation_mode="SHARED", - external_recipients=[ - JsonApiAutomationInAttributesExternalRecipientsInner( - email="email_example", - ), - ], - image_exports=[ - JsonApiAutomationInAttributesImageExportsInner( - request_payload=ImageExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PNG", - metadata=JsonNode(), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - metadata=JsonApiAutomationInAttributesMetadata(), - raw_exports=[ - JsonApiAutomationInAttributesRawExportsInner( - request_payload=RawExportAutomationRequest( - custom_override=RawCustomOverride( - labels={ - "key": RawCustomLabel( - title="title_example", - ), - }, - metrics={ - "key": RawCustomMetric( - title="title_example", - ), - }, - ), - delimiter="U", - execution=AFM( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measure_definition_overrides=[ - MetricDefinitionOverride( - definition=InlineMeasureDefinition( - inline=InlineMeasureDefinitionInline( - maql="maql_example", - ), - ), - item=AfmObjectIdentifierCore( - identifier=AfmObjectIdentifierCoreIdentifier( - id="sample_item.price", - type="attribute", - ), - ), - ), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - execution_settings=ExecutionSettings( - data_sampling_percentage=0, - timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), - ), - file_name="result", - format="CSV", - metadata=JsonNode(), - ), - ), - ], - schedule=JsonApiAutomationInAttributesSchedule( - cron="0 */30 9-17 ? * MON-FRI", - first_run=dateutil_parser('2025-01-01T12:00:00Z'), - timezone="Europe/Prague", - ), - slides_exports=[ - JsonApiAutomationInAttributesSlidesExportsInner( - request_payload=SlidesExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PDF", - metadata=JsonNode(), - template_id="template_id_example", - visualization_ids=[ - "visualization_ids_example", - ], - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - state="ACTIVE", - tabular_exports=[ - JsonApiAutomationInAttributesTabularExportsInner( - request_payload=TabularExportRequest( - custom_override=CustomOverride( - labels={ - "key": CustomLabel( - title="title_example", - ), - }, - metrics={ - "key": CustomMetric( - format="format_example", - title="title_example", - ), - }, - ), - execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", - file_name="result", - format="CSV", - metadata=JsonNode(), - related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - settings=Settings( - delimiter="U", - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - pdf_page_size="a4 landscape", - pdf_table_style=[ - PdfTableStyle( - properties=[ - PdfTableStyleProperty( - key="key_example", - value="value_example", - ), - ], - selector="selector_example", - ), - ], - pdf_top_left_content="Good", - pdf_top_right_content="Morning", - show_filters=False, - ), - visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", - visualization_object_custom_filters=[ - {}, - ], - ), - ), - ], - tags=[ - "tags_example", - ], - title="title_example", - visual_exports=[ - JsonApiAutomationInAttributesVisualExportsInner( - request_payload=VisualExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - metadata={}, - ), - ), - ], - ), - id="id1", - relationships=JsonApiAutomationInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - export_definitions=JsonApiAutomationInRelationshipsExportDefinitions( - data=JsonApiExportDefinitionToManyLinkage([ - JsonApiExportDefinitionLinkage( - id="id_example", - type="exportDefinition", - ), - ]), - ), - notification_channel=JsonApiAutomationInRelationshipsNotificationChannel( - data=JsonApiNotificationChannelToOneLinkage(None), - ), - recipients=JsonApiAutomationInRelationshipsRecipients( - data=JsonApiUserToManyLinkage([ - JsonApiUserLinkage( - id="id_example", - type="user", - ), - ]), - ), - ), - type="automation", - ), - ) # JsonApiAutomationInDocument | - include = [ - "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) # example passing only required values which don't have defaults set try: - # Post Automations - api_response = api_instance.create_entity_automations(workspace_id, json_api_automation_in_document) - pprint(api_response) + api_instance.delete_entity_knowledge_recommendations(workspace_id, object_id) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_automations: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->delete_entity_knowledge_recommendations: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Post Automations - api_response = api_instance.create_entity_automations(workspace_id, json_api_automation_in_document, include=include, meta_include=meta_include) - pprint(api_response) + api_instance.delete_entity_knowledge_recommendations(workspace_id, object_id, filter=filter) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_automations: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->delete_entity_knowledge_recommendations: %s\n" % e) ``` @@ -666,13 +291,12 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | - **json_api_automation_in_document** | [**JsonApiAutomationInDocument**](JsonApiAutomationInDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type -[**JsonApiAutomationOutDocument**](JsonApiAutomationOutDocument.md) +void (empty response body) ### Authorization @@ -680,22 +304,22 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json + - **Content-Type**: Not defined + - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | Request successfully processed | - | +**204** | Successfully deleted | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **create_entity_custom_application_settings** -> JsonApiCustomApplicationSettingOutDocument create_entity_custom_application_settings(workspace_id, json_api_custom_application_setting_post_optional_id_document) +# **delete_entity_memory_items** +> delete_entity_memory_items(workspace_id, object_id) + -Post Custom Application Settings ### Example @@ -704,8 +328,6 @@ Post Custom Application Settings import time import gooddata_api_client from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument -from gooddata_api_client.model.json_api_custom_application_setting_post_optional_id_document import JsonApiCustomApplicationSettingPostOptionalIdDocument 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. @@ -719,36 +341,21 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) workspace_id = "workspaceId_example" # str | - json_api_custom_application_setting_post_optional_id_document = JsonApiCustomApplicationSettingPostOptionalIdDocument( - data=JsonApiCustomApplicationSettingPostOptionalId( - attributes=JsonApiCustomApplicationSettingInAttributes( - application_name="application_name_example", - content={}, - ), - id="id1", - type="customApplicationSetting", - ), - ) # JsonApiCustomApplicationSettingPostOptionalIdDocument | - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) # example passing only required values which don't have defaults set try: - # Post Custom Application Settings - api_response = api_instance.create_entity_custom_application_settings(workspace_id, json_api_custom_application_setting_post_optional_id_document) - pprint(api_response) + api_instance.delete_entity_memory_items(workspace_id, object_id) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_custom_application_settings: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->delete_entity_memory_items: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Post Custom Application Settings - api_response = api_instance.create_entity_custom_application_settings(workspace_id, json_api_custom_application_setting_post_optional_id_document, meta_include=meta_include) - pprint(api_response) + api_instance.delete_entity_memory_items(workspace_id, object_id, filter=filter) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_custom_application_settings: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->delete_entity_memory_items: %s\n" % e) ``` @@ -757,12 +364,12 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | - **json_api_custom_application_setting_post_optional_id_document** | [**JsonApiCustomApplicationSettingPostOptionalIdDocument**](JsonApiCustomApplicationSettingPostOptionalIdDocument.md)| | - **meta_include** | **[str]**| Include Meta objects. | [optional] + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type -[**JsonApiCustomApplicationSettingOutDocument**](JsonApiCustomApplicationSettingOutDocument.md) +void (empty response body) ### Authorization @@ -770,22 +377,22 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json + - **Content-Type**: Not defined + - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | Request successfully processed | - | +**204** | Successfully deleted | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **create_entity_dashboard_plugins** -> JsonApiDashboardPluginOutDocument create_entity_dashboard_plugins(workspace_id, json_api_dashboard_plugin_post_optional_id_document) +# **get_all_entities_aggregated_facts** +> JsonApiAggregatedFactOutList get_all_entities_aggregated_facts(workspace_id) + -Post Plugins ### Example @@ -794,8 +401,7 @@ Post Plugins import time import gooddata_api_client from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_dashboard_plugin_post_optional_id_document import JsonApiDashboardPluginPostOptionalIdDocument -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.model.json_api_aggregated_fact_out_list import JsonApiAggregatedFactOutList 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. @@ -809,44 +415,35 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) workspace_id = "workspaceId_example" # str | - json_api_dashboard_plugin_post_optional_id_document = JsonApiDashboardPluginPostOptionalIdDocument( - data=JsonApiDashboardPluginPostOptionalId( - attributes=JsonApiDashboardPluginInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="dashboardPlugin", - ), - ) # JsonApiDashboardPluginPostOptionalIdDocument | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy", + "dataset,sourceFact", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False meta_include = [ - "metaInclude=origin,all", + "metaInclude=origin,page,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Post Plugins - api_response = api_instance.create_entity_dashboard_plugins(workspace_id, json_api_dashboard_plugin_post_optional_id_document) + api_response = api_instance.get_all_entities_aggregated_facts(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_dashboard_plugins: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_aggregated_facts: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Post Plugins - api_response = api_instance.create_entity_dashboard_plugins(workspace_id, json_api_dashboard_plugin_post_optional_id_document, include=include, meta_include=meta_include) + api_response = api_instance.get_all_entities_aggregated_facts(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_dashboard_plugins: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_aggregated_facts: %s\n" % e) ``` @@ -855,13 +452,18 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | - **json_api_dashboard_plugin_post_optional_id_document** | [**JsonApiDashboardPluginPostOptionalIdDocument**](JsonApiDashboardPluginPostOptionalIdDocument.md)| | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -[**JsonApiDashboardPluginOutDocument**](JsonApiDashboardPluginOutDocument.md) +[**JsonApiAggregatedFactOutList**](JsonApiAggregatedFactOutList.md) ### Authorization @@ -869,7 +471,7 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Content-Type**: Not defined - **Accept**: application/json, application/vnd.gooddata.api+json @@ -877,14 +479,14 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | Request successfully processed | - | +**200** | Request successfully processed | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **create_entity_export_definitions** -> JsonApiExportDefinitionOutDocument create_entity_export_definitions(workspace_id, json_api_export_definition_post_optional_id_document) +# **get_all_entities_knowledge_recommendations** +> JsonApiKnowledgeRecommendationOutList get_all_entities_knowledge_recommendations(workspace_id) + -Post Export Definitions ### Example @@ -893,8 +495,7 @@ Post Export Definitions import time import gooddata_api_client from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument -from gooddata_api_client.model.json_api_export_definition_post_optional_id_document import JsonApiExportDefinitionPostOptionalIdDocument +from gooddata_api_client.model.json_api_knowledge_recommendation_out_list import JsonApiKnowledgeRecommendationOutList 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. @@ -908,52 +509,35 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) workspace_id = "workspaceId_example" # str | - json_api_export_definition_post_optional_id_document = JsonApiExportDefinitionPostOptionalIdDocument( - data=JsonApiExportDefinitionPostOptionalId( - attributes=JsonApiExportDefinitionInAttributes( - are_relations_valid=True, - description="description_example", - request_payload=JsonApiExportDefinitionInAttributesRequestPayload(), - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiExportDefinitionInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - visualization_object=JsonApiExportDefinitionInRelationshipsVisualizationObject( - data=JsonApiVisualizationObjectToOneLinkage(None), - ), - ), - type="exportDefinition", - ), - ) # JsonApiExportDefinitionPostOptionalIdDocument | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", + "metric,analyticalDashboard", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False meta_include = [ - "metaInclude=origin,all", + "metaInclude=origin,page,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Post Export Definitions - api_response = api_instance.create_entity_export_definitions(workspace_id, json_api_export_definition_post_optional_id_document) + api_response = api_instance.get_all_entities_knowledge_recommendations(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_export_definitions: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_knowledge_recommendations: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Post Export Definitions - api_response = api_instance.create_entity_export_definitions(workspace_id, json_api_export_definition_post_optional_id_document, include=include, meta_include=meta_include) + api_response = api_instance.get_all_entities_knowledge_recommendations(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_export_definitions: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_knowledge_recommendations: %s\n" % e) ``` @@ -962,13 +546,18 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | - **json_api_export_definition_post_optional_id_document** | [**JsonApiExportDefinitionPostOptionalIdDocument**](JsonApiExportDefinitionPostOptionalIdDocument.md)| | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -[**JsonApiExportDefinitionOutDocument**](JsonApiExportDefinitionOutDocument.md) +[**JsonApiKnowledgeRecommendationOutList**](JsonApiKnowledgeRecommendationOutList.md) ### Authorization @@ -976,7 +565,7 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Content-Type**: Not defined - **Accept**: application/json, application/vnd.gooddata.api+json @@ -984,14 +573,14 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | Request successfully processed | - | +**200** | Request successfully processed | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **create_entity_filter_contexts** -> JsonApiFilterContextOutDocument create_entity_filter_contexts(workspace_id, json_api_filter_context_post_optional_id_document) +# **get_all_entities_memory_items** +> JsonApiMemoryItemOutList get_all_entities_memory_items(workspace_id) + -Post Filter Context ### Example @@ -1000,8 +589,7 @@ Post Filter Context import time import gooddata_api_client from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_filter_context_post_optional_id_document import JsonApiFilterContextPostOptionalIdDocument -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.model.json_api_memory_item_out_list import JsonApiMemoryItemOutList 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. @@ -1015,44 +603,35 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) workspace_id = "workspaceId_example" # str | - json_api_filter_context_post_optional_id_document = JsonApiFilterContextPostOptionalIdDocument( - data=JsonApiFilterContextPostOptionalId( - attributes=JsonApiFilterContextInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="filterContext", - ), - ) # JsonApiFilterContextPostOptionalIdDocument | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "attributes,datasets,labels", + "createdBy,modifiedBy", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False meta_include = [ - "metaInclude=origin,all", + "metaInclude=origin,page,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Post Filter Context - api_response = api_instance.create_entity_filter_contexts(workspace_id, json_api_filter_context_post_optional_id_document) + api_response = api_instance.get_all_entities_memory_items(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_filter_contexts: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_memory_items: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Post Filter Context - api_response = api_instance.create_entity_filter_contexts(workspace_id, json_api_filter_context_post_optional_id_document, include=include, meta_include=meta_include) + api_response = api_instance.get_all_entities_memory_items(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_filter_contexts: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_memory_items: %s\n" % e) ``` @@ -1061,13 +640,18 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | - **json_api_filter_context_post_optional_id_document** | [**JsonApiFilterContextPostOptionalIdDocument**](JsonApiFilterContextPostOptionalIdDocument.md)| | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -[**JsonApiFilterContextOutDocument**](JsonApiFilterContextOutDocument.md) +[**JsonApiMemoryItemOutList**](JsonApiMemoryItemOutList.md) ### Authorization @@ -1075,7 +659,7 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Content-Type**: Not defined - **Accept**: application/json, application/vnd.gooddata.api+json @@ -1083,14 +667,14 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | Request successfully processed | - | +**200** | Request successfully processed | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **create_entity_filter_views** -> JsonApiFilterViewOutDocument create_entity_filter_views(workspace_id, json_api_filter_view_in_document) +# **get_entity_aggregated_facts** +> JsonApiAggregatedFactOutDocument get_entity_aggregated_facts(workspace_id, object_id) + -Post Filter views ### Example @@ -1099,8 +683,7 @@ Post Filter views import time import gooddata_api_client from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_filter_view_in_document import JsonApiFilterViewInDocument -from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +from gooddata_api_client.model.json_api_aggregated_fact_out_document import JsonApiAggregatedFactOutDocument 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. @@ -1114,50 +697,30 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) workspace_id = "workspaceId_example" # str | - json_api_filter_view_in_document = JsonApiFilterViewInDocument( - data=JsonApiFilterViewIn( - attributes=JsonApiFilterViewInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - is_default=True, - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiFilterViewInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - user=JsonApiFilterViewInRelationshipsUser( - data=JsonApiUserToOneLinkage(None), - ), - ), - type="filterView", - ), - ) # JsonApiFilterViewInDocument | + object_id = "objectId_example" # str | + filter = "description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "analyticalDashboard,user", + "dataset,sourceFact", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Post Filter views - api_response = api_instance.create_entity_filter_views(workspace_id, json_api_filter_view_in_document) + api_response = api_instance.get_entity_aggregated_facts(workspace_id, object_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_filter_views: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->get_entity_aggregated_facts: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Post Filter views - api_response = api_instance.create_entity_filter_views(workspace_id, json_api_filter_view_in_document, include=include) + api_response = api_instance.get_entity_aggregated_facts(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_filter_views: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->get_entity_aggregated_facts: %s\n" % e) ``` @@ -1166,12 +729,15 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | - **json_api_filter_view_in_document** | [**JsonApiFilterViewInDocument**](JsonApiFilterViewInDocument.md)| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -[**JsonApiFilterViewOutDocument**](JsonApiFilterViewOutDocument.md) +[**JsonApiAggregatedFactOutDocument**](JsonApiAggregatedFactOutDocument.md) ### Authorization @@ -1179,7 +745,7 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Content-Type**: Not defined - **Accept**: application/json, application/vnd.gooddata.api+json @@ -1187,12 +753,12 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | Request successfully processed | - | +**200** | Request successfully processed | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **create_entity_knowledge_recommendations** -> JsonApiKnowledgeRecommendationOutDocument create_entity_knowledge_recommendations(workspace_id, json_api_knowledge_recommendation_post_optional_id_document) +# **get_entity_knowledge_recommendations** +> JsonApiKnowledgeRecommendationOutDocument get_entity_knowledge_recommendations(workspace_id, object_id) @@ -1204,7 +770,6 @@ import time import gooddata_api_client from gooddata_api_client.api import workspace_object_controller_api from gooddata_api_client.model.json_api_knowledge_recommendation_out_document import JsonApiKnowledgeRecommendationOutDocument -from gooddata_api_client.model.json_api_knowledge_recommendation_post_optional_id_document import JsonApiKnowledgeRecommendationPostOptionalIdDocument 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. @@ -1218,62 +783,30 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) workspace_id = "workspaceId_example" # str | - json_api_knowledge_recommendation_post_optional_id_document = JsonApiKnowledgeRecommendationPostOptionalIdDocument( - data=JsonApiKnowledgeRecommendationPostOptionalId( - attributes=JsonApiKnowledgeRecommendationInAttributes( - analytical_dashboard_title="Portfolio Health Insights", - analyzed_period="2023-07", - analyzed_value=None, - are_relations_valid=True, - comparison_type="MONTH", - confidence=None, - description="description_example", - direction="DECREASED", - metric_title="Revenue", - recommendations={}, - reference_period="2023-06", - reference_value=None, - source_count=2, - tags=[ - "tags_example", - ], - title="title_example", - widget_id="widget-123", - widget_name="Revenue Trend", - ), - id="id1", - relationships=JsonApiKnowledgeRecommendationInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - metric=JsonApiKnowledgeRecommendationInRelationshipsMetric( - data=JsonApiMetricToOneLinkage(None), - ), - ), - type="knowledgeRecommendation", - ), - ) # JsonApiKnowledgeRecommendationPostOptionalIdDocument | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ "metric,analyticalDashboard", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False meta_include = [ "metaInclude=origin,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - api_response = api_instance.create_entity_knowledge_recommendations(workspace_id, json_api_knowledge_recommendation_post_optional_id_document) + api_response = api_instance.get_entity_knowledge_recommendations(workspace_id, object_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_knowledge_recommendations: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->get_entity_knowledge_recommendations: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - api_response = api_instance.create_entity_knowledge_recommendations(workspace_id, json_api_knowledge_recommendation_post_optional_id_document, include=include, meta_include=meta_include) + api_response = api_instance.get_entity_knowledge_recommendations(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_knowledge_recommendations: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->get_entity_knowledge_recommendations: %s\n" % e) ``` @@ -1282,8 +815,10 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | - **json_api_knowledge_recommendation_post_optional_id_document** | [**JsonApiKnowledgeRecommendationPostOptionalIdDocument**](JsonApiKnowledgeRecommendationPostOptionalIdDocument.md)| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type @@ -1296,7 +831,7 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Content-Type**: Not defined - **Accept**: application/json, application/vnd.gooddata.api+json @@ -1304,12 +839,12 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | Request successfully processed | - | +**200** | Request successfully processed | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **create_entity_memory_items** -> JsonApiMemoryItemOutDocument create_entity_memory_items(workspace_id, json_api_memory_item_post_optional_id_document) +# **get_entity_memory_items** +> JsonApiMemoryItemOutDocument get_entity_memory_items(workspace_id, object_id) @@ -1320,7 +855,6 @@ No authorization required import time import gooddata_api_client from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_memory_item_post_optional_id_document import JsonApiMemoryItemPostOptionalIdDocument from gooddata_api_client.model.json_api_memory_item_out_document import JsonApiMemoryItemOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost @@ -1335,47 +869,30 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) workspace_id = "workspaceId_example" # str | - json_api_memory_item_post_optional_id_document = JsonApiMemoryItemPostOptionalIdDocument( - data=JsonApiMemoryItemPostOptionalId( - attributes=JsonApiMemoryItemInAttributes( - are_relations_valid=True, - description="description_example", - instruction="instruction_example", - is_disabled=True, - keywords=[ - "keywords_example", - ], - strategy="ALWAYS", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="memoryItem", - ), - ) # JsonApiMemoryItemPostOptionalIdDocument | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ "createdBy,modifiedBy", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False meta_include = [ "metaInclude=origin,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - api_response = api_instance.create_entity_memory_items(workspace_id, json_api_memory_item_post_optional_id_document) + api_response = api_instance.get_entity_memory_items(workspace_id, object_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_memory_items: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->get_entity_memory_items: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - api_response = api_instance.create_entity_memory_items(workspace_id, json_api_memory_item_post_optional_id_document, include=include, meta_include=meta_include) + api_response = api_instance.get_entity_memory_items(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_memory_items: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->get_entity_memory_items: %s\n" % e) ``` @@ -1384,8 +901,10 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | - **json_api_memory_item_post_optional_id_document** | [**JsonApiMemoryItemPostOptionalIdDocument**](JsonApiMemoryItemPostOptionalIdDocument.md)| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type @@ -1398,7 +917,7 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Content-Type**: Not defined - **Accept**: application/json, application/vnd.gooddata.api+json @@ -1406,14 +925,14 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | Request successfully processed | - | +**200** | Request successfully processed | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **create_entity_metrics** -> JsonApiMetricOutDocument create_entity_metrics(workspace_id, json_api_metric_post_optional_id_document) +# **patch_entity_knowledge_recommendations** +> JsonApiKnowledgeRecommendationOutDocument patch_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_patch_document) + -Post Metrics ### Example @@ -1422,8 +941,8 @@ Post Metrics import time import gooddata_api_client from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_metric_post_optional_id_document import JsonApiMetricPostOptionalIdDocument -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.model.json_api_knowledge_recommendation_patch_document import JsonApiKnowledgeRecommendationPatchDocument +from gooddata_api_client.model.json_api_knowledge_recommendation_out_document import JsonApiKnowledgeRecommendationOutDocument 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. @@ -1437,50 +956,61 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) workspace_id = "workspaceId_example" # str | - json_api_metric_post_optional_id_document = JsonApiMetricPostOptionalIdDocument( - data=JsonApiMetricPostOptionalId( - attributes=JsonApiMetricInAttributes( + object_id = "objectId_example" # str | + json_api_knowledge_recommendation_patch_document = JsonApiKnowledgeRecommendationPatchDocument( + data=JsonApiKnowledgeRecommendationPatch( + attributes=JsonApiKnowledgeRecommendationPatchAttributes( + analytical_dashboard_title="Portfolio Health Insights", + analyzed_period="2023-07", + analyzed_value=None, are_relations_valid=True, - content=JsonApiMetricInAttributesContent( - format="format_example", - maql="maql_example", - metric_type="UNSPECIFIED", - ), + comparison_type="MONTH", + confidence=None, description="description_example", - is_hidden=True, - is_hidden_from_kda=True, + direction="DECREASED", + metric_title="Revenue", + recommendations={}, + reference_period="2023-06", + reference_value=None, + source_count=2, tags=[ "tags_example", ], title="title_example", + widget_id="widget-123", + widget_name="Revenue Trend", ), id="id1", - type="metric", + relationships=JsonApiKnowledgeRecommendationOutRelationships( + analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + metric=JsonApiKnowledgeRecommendationInRelationshipsMetric( + data=JsonApiMetricToOneLinkage(None), + ), + ), + type="knowledgeRecommendation", ), - ) # JsonApiMetricPostOptionalIdDocument | + ) # JsonApiKnowledgeRecommendationPatchDocument | + filter = "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", + "metric,analyticalDashboard", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Post Metrics - api_response = api_instance.create_entity_metrics(workspace_id, json_api_metric_post_optional_id_document) + api_response = api_instance.patch_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_metrics: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->patch_entity_knowledge_recommendations: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Post Metrics - api_response = api_instance.create_entity_metrics(workspace_id, json_api_metric_post_optional_id_document, include=include, meta_include=meta_include) + api_response = api_instance.patch_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_patch_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_metrics: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->patch_entity_knowledge_recommendations: %s\n" % e) ``` @@ -1489,13 +1019,14 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | - **json_api_metric_post_optional_id_document** | [**JsonApiMetricPostOptionalIdDocument**](JsonApiMetricPostOptionalIdDocument.md)| | + **object_id** | **str**| | + **json_api_knowledge_recommendation_patch_document** | [**JsonApiKnowledgeRecommendationPatchDocument**](JsonApiKnowledgeRecommendationPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -[**JsonApiMetricOutDocument**](JsonApiMetricOutDocument.md) +[**JsonApiKnowledgeRecommendationOutDocument**](JsonApiKnowledgeRecommendationOutDocument.md) ### Authorization @@ -1511,14 +1042,14 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | Request successfully processed | - | +**200** | Request successfully processed | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **create_entity_user_data_filters** -> JsonApiUserDataFilterOutDocument create_entity_user_data_filters(workspace_id, json_api_user_data_filter_post_optional_id_document) +# **patch_entity_memory_items** +> JsonApiMemoryItemOutDocument patch_entity_memory_items(workspace_id, object_id, json_api_memory_item_patch_document) + -Post User Data Filters ### Example @@ -1527,8 +1058,8 @@ Post User Data Filters import time import gooddata_api_client from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument -from gooddata_api_client.model.json_api_user_data_filter_post_optional_id_document import JsonApiUserDataFilterPostOptionalIdDocument +from gooddata_api_client.model.json_api_memory_item_patch_document import JsonApiMemoryItemPatchDocument +from gooddata_api_client.model.json_api_memory_item_out_document import JsonApiMemoryItemOutDocument 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. @@ -1542,52 +1073,46 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) workspace_id = "workspaceId_example" # str | - json_api_user_data_filter_post_optional_id_document = JsonApiUserDataFilterPostOptionalIdDocument( - data=JsonApiUserDataFilterPostOptionalId( - attributes=JsonApiUserDataFilterInAttributes( + object_id = "objectId_example" # str | + json_api_memory_item_patch_document = JsonApiMemoryItemPatchDocument( + data=JsonApiMemoryItemPatch( + attributes=JsonApiMemoryItemPatchAttributes( are_relations_valid=True, description="description_example", - maql="maql_example", + instruction="instruction_example", + is_disabled=True, + keywords=[ + "keywords_example", + ], + strategy="ALWAYS", tags=[ "tags_example", ], title="title_example", ), id="id1", - relationships=JsonApiUserDataFilterInRelationships( - user=JsonApiFilterViewInRelationshipsUser( - data=JsonApiUserToOneLinkage(None), - ), - user_group=JsonApiOrganizationOutRelationshipsBootstrapUserGroup( - data=JsonApiUserGroupToOneLinkage(None), - ), - ), - type="userDataFilter", + type="memoryItem", ), - ) # JsonApiUserDataFilterPostOptionalIdDocument | + ) # JsonApiMemoryItemPatchDocument | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "user,userGroup,facts,attributes,labels,metrics,datasets", + "createdBy,modifiedBy", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Post User Data Filters - api_response = api_instance.create_entity_user_data_filters(workspace_id, json_api_user_data_filter_post_optional_id_document) + api_response = api_instance.patch_entity_memory_items(workspace_id, object_id, json_api_memory_item_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_user_data_filters: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->patch_entity_memory_items: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Post User Data Filters - api_response = api_instance.create_entity_user_data_filters(workspace_id, json_api_user_data_filter_post_optional_id_document, include=include, meta_include=meta_include) + api_response = api_instance.patch_entity_memory_items(workspace_id, object_id, json_api_memory_item_patch_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_user_data_filters: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->patch_entity_memory_items: %s\n" % e) ``` @@ -1596,13 +1121,14 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | - **json_api_user_data_filter_post_optional_id_document** | [**JsonApiUserDataFilterPostOptionalIdDocument**](JsonApiUserDataFilterPostOptionalIdDocument.md)| | + **object_id** | **str**| | + **json_api_memory_item_patch_document** | [**JsonApiMemoryItemPatchDocument**](JsonApiMemoryItemPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -[**JsonApiUserDataFilterOutDocument**](JsonApiUserDataFilterOutDocument.md) +[**JsonApiMemoryItemOutDocument**](JsonApiMemoryItemOutDocument.md) ### Authorization @@ -1618,14 +1144,14 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | Request successfully processed | - | +**200** | Request successfully processed | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **create_entity_visualization_objects** -> JsonApiVisualizationObjectOutDocument create_entity_visualization_objects(workspace_id, json_api_visualization_object_post_optional_id_document) +# **search_entities_aggregated_facts** +> JsonApiAggregatedFactOutList search_entities_aggregated_facts(workspace_id, entity_search_body) -Post Visualization Objects +Search request for AggregatedFact ### Example @@ -1634,8 +1160,8 @@ Post Visualization Objects import time import gooddata_api_client from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument -from gooddata_api_client.model.json_api_visualization_object_post_optional_id_document import JsonApiVisualizationObjectPostOptionalIdDocument +from gooddata_api_client.model.json_api_aggregated_fact_out_list import JsonApiAggregatedFactOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody 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. @@ -1649,11202 +1175,44 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) workspace_id = "workspaceId_example" # str | - json_api_visualization_object_post_optional_id_document = JsonApiVisualizationObjectPostOptionalIdDocument( - data=JsonApiVisualizationObjectPostOptionalId( - attributes=JsonApiVisualizationObjectInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - is_hidden=True, - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="visualizationObject", - ), - ) # JsonApiVisualizationObjectPostOptionalIdDocument | - include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Visualization Objects - api_response = api_instance.create_entity_visualization_objects(workspace_id, json_api_visualization_object_post_optional_id_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_visualization_objects: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Post Visualization Objects - api_response = api_instance.create_entity_visualization_objects(workspace_id, json_api_visualization_object_post_optional_id_document, include=include, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_visualization_objects: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_visualization_object_post_optional_id_document** | [**JsonApiVisualizationObjectPostOptionalIdDocument**](JsonApiVisualizationObjectPostOptionalIdDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiVisualizationObjectOutDocument**](JsonApiVisualizationObjectOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_entity_workspace_data_filter_settings** -> JsonApiWorkspaceDataFilterSettingOutDocument create_entity_workspace_data_filter_settings(workspace_id, json_api_workspace_data_filter_setting_in_document) - -Post Settings for Workspace Data Filters - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_data_filter_setting_in_document import JsonApiWorkspaceDataFilterSettingInDocument -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_workspace_data_filter_setting_in_document = JsonApiWorkspaceDataFilterSettingInDocument( - data=JsonApiWorkspaceDataFilterSettingIn( - attributes=JsonApiWorkspaceDataFilterSettingInAttributes( - description="description_example", - filter_values=[ - "filter_values_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiWorkspaceDataFilterSettingInRelationships( - workspace_data_filter=JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter( - data=JsonApiWorkspaceDataFilterToOneLinkage(None), - ), - ), - type="workspaceDataFilterSetting", - ), - ) # JsonApiWorkspaceDataFilterSettingInDocument | - include = [ - "workspaceDataFilter", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Settings for Workspace Data Filters - api_response = api_instance.create_entity_workspace_data_filter_settings(workspace_id, json_api_workspace_data_filter_setting_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_workspace_data_filter_settings: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Post Settings for Workspace Data Filters - api_response = api_instance.create_entity_workspace_data_filter_settings(workspace_id, json_api_workspace_data_filter_setting_in_document, include=include, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_workspace_data_filter_settings: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_workspace_data_filter_setting_in_document** | [**JsonApiWorkspaceDataFilterSettingInDocument**](JsonApiWorkspaceDataFilterSettingInDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiWorkspaceDataFilterSettingOutDocument**](JsonApiWorkspaceDataFilterSettingOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_entity_workspace_data_filters** -> JsonApiWorkspaceDataFilterOutDocument create_entity_workspace_data_filters(workspace_id, json_api_workspace_data_filter_in_document) - -Post Workspace Data Filters - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_workspace_data_filter_in_document = JsonApiWorkspaceDataFilterInDocument( - data=JsonApiWorkspaceDataFilterIn( - attributes=JsonApiWorkspaceDataFilterInAttributes( - column_name="column_name_example", - description="description_example", - title="title_example", - ), - id="id1", - relationships=JsonApiWorkspaceDataFilterInRelationships( - filter_settings=JsonApiWorkspaceDataFilterInRelationshipsFilterSettings( - data=JsonApiWorkspaceDataFilterSettingToManyLinkage([ - JsonApiWorkspaceDataFilterSettingLinkage( - id="id_example", - type="workspaceDataFilterSetting", - ), - ]), - ), - ), - type="workspaceDataFilter", - ), - ) # JsonApiWorkspaceDataFilterInDocument | - include = [ - "filterSettings", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Workspace Data Filters - api_response = api_instance.create_entity_workspace_data_filters(workspace_id, json_api_workspace_data_filter_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_workspace_data_filters: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Post Workspace Data Filters - api_response = api_instance.create_entity_workspace_data_filters(workspace_id, json_api_workspace_data_filter_in_document, include=include, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_workspace_data_filters: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_workspace_data_filter_in_document** | [**JsonApiWorkspaceDataFilterInDocument**](JsonApiWorkspaceDataFilterInDocument.md)| | - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiWorkspaceDataFilterOutDocument**](JsonApiWorkspaceDataFilterOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_entity_workspace_settings** -> JsonApiWorkspaceSettingOutDocument create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document) - -Post Settings for Workspaces - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_workspace_setting_post_optional_id_document = JsonApiWorkspaceSettingPostOptionalIdDocument( - data=JsonApiWorkspaceSettingPostOptionalId( - attributes=JsonApiOrganizationSettingInAttributes( - content={}, - type="TIMEZONE", - ), - id="id1", - type="workspaceSetting", - ), - ) # JsonApiWorkspaceSettingPostOptionalIdDocument | - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Settings for Workspaces - api_response = api_instance.create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_workspace_settings: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Post Settings for Workspaces - api_response = api_instance.create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->create_entity_workspace_settings: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_workspace_setting_post_optional_id_document** | [**JsonApiWorkspaceSettingPostOptionalIdDocument**](JsonApiWorkspaceSettingPostOptionalIdDocument.md)| | - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiWorkspaceSettingOutDocument**](JsonApiWorkspaceSettingOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_entity_analytical_dashboards** -> delete_entity_analytical_dashboards(workspace_id, object_id) - -Delete a Dashboard - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete a Dashboard - api_instance.delete_entity_analytical_dashboards(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_analytical_dashboards: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Delete a Dashboard - api_instance.delete_entity_analytical_dashboards(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_analytical_dashboards: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Successfully deleted | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_entity_attribute_hierarchies** -> delete_entity_attribute_hierarchies(workspace_id, object_id) - -Delete an Attribute Hierarchy - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete an Attribute Hierarchy - api_instance.delete_entity_attribute_hierarchies(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_attribute_hierarchies: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Delete an Attribute Hierarchy - api_instance.delete_entity_attribute_hierarchies(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_attribute_hierarchies: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Successfully deleted | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_entity_automations** -> delete_entity_automations(workspace_id, object_id) - -Delete an Automation - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete an Automation - api_instance.delete_entity_automations(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_automations: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Delete an Automation - api_instance.delete_entity_automations(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_automations: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Successfully deleted | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_entity_custom_application_settings** -> delete_entity_custom_application_settings(workspace_id, object_id) - -Delete a Custom Application Setting - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "applicationName==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete a Custom Application Setting - api_instance.delete_entity_custom_application_settings(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_custom_application_settings: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Delete a Custom Application Setting - api_instance.delete_entity_custom_application_settings(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_custom_application_settings: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Successfully deleted | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_entity_dashboard_plugins** -> delete_entity_dashboard_plugins(workspace_id, object_id) - -Delete a Plugin - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete a Plugin - api_instance.delete_entity_dashboard_plugins(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_dashboard_plugins: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Delete a Plugin - api_instance.delete_entity_dashboard_plugins(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_dashboard_plugins: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Successfully deleted | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_entity_export_definitions** -> delete_entity_export_definitions(workspace_id, object_id) - -Delete an Export Definition - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete an Export Definition - api_instance.delete_entity_export_definitions(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_export_definitions: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Delete an Export Definition - api_instance.delete_entity_export_definitions(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_export_definitions: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Successfully deleted | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_entity_filter_contexts** -> delete_entity_filter_contexts(workspace_id, object_id) - -Delete a Filter Context - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete a Filter Context - api_instance.delete_entity_filter_contexts(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_filter_contexts: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Delete a Filter Context - api_instance.delete_entity_filter_contexts(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_filter_contexts: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Successfully deleted | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_entity_filter_views** -> delete_entity_filter_views(workspace_id, object_id) - -Delete Filter view - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;analyticalDashboard.id==321;user.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete Filter view - api_instance.delete_entity_filter_views(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_filter_views: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Delete Filter view - api_instance.delete_entity_filter_views(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_filter_views: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Successfully deleted | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_entity_knowledge_recommendations** -> delete_entity_knowledge_recommendations(workspace_id, object_id) - - - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - api_instance.delete_entity_knowledge_recommendations(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_knowledge_recommendations: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_instance.delete_entity_knowledge_recommendations(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_knowledge_recommendations: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Successfully deleted | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_entity_memory_items** -> delete_entity_memory_items(workspace_id, object_id) - - - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - api_instance.delete_entity_memory_items(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_memory_items: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_instance.delete_entity_memory_items(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_memory_items: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Successfully deleted | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_entity_metrics** -> delete_entity_metrics(workspace_id, object_id) - -Delete a Metric - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete a Metric - api_instance.delete_entity_metrics(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_metrics: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Delete a Metric - api_instance.delete_entity_metrics(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_metrics: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Successfully deleted | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_entity_user_data_filters** -> delete_entity_user_data_filters(workspace_id, object_id) - -Delete a User Data Filter - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;user.id==321;userGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete a User Data Filter - api_instance.delete_entity_user_data_filters(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_user_data_filters: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Delete a User Data Filter - api_instance.delete_entity_user_data_filters(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_user_data_filters: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Successfully deleted | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_entity_visualization_objects** -> delete_entity_visualization_objects(workspace_id, object_id) - -Delete a Visualization Object - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete a Visualization Object - api_instance.delete_entity_visualization_objects(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_visualization_objects: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Delete a Visualization Object - api_instance.delete_entity_visualization_objects(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_visualization_objects: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Successfully deleted | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_entity_workspace_data_filter_settings** -> delete_entity_workspace_data_filter_settings(workspace_id, object_id) - -Delete a Settings for Workspace Data Filter - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;workspaceDataFilter.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete a Settings for Workspace Data Filter - api_instance.delete_entity_workspace_data_filter_settings(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_workspace_data_filter_settings: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Delete a Settings for Workspace Data Filter - api_instance.delete_entity_workspace_data_filter_settings(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_workspace_data_filter_settings: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Successfully deleted | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_entity_workspace_data_filters** -> delete_entity_workspace_data_filters(workspace_id, object_id) - -Delete a Workspace Data Filter - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete a Workspace Data Filter - api_instance.delete_entity_workspace_data_filters(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_workspace_data_filters: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Delete a Workspace Data Filter - api_instance.delete_entity_workspace_data_filters(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_workspace_data_filters: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Successfully deleted | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_entity_workspace_settings** -> delete_entity_workspace_settings(workspace_id, object_id) - -Delete a Setting for Workspace - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Delete a Setting for Workspace - api_instance.delete_entity_workspace_settings(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_workspace_settings: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Delete a Setting for Workspace - api_instance.delete_entity_workspace_settings(workspace_id, object_id, filter=filter) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->delete_entity_workspace_settings: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Successfully deleted | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_entities_aggregated_facts** -> JsonApiAggregatedFactOutList get_all_entities_aggregated_facts(workspace_id) - - - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_aggregated_fact_out_list import JsonApiAggregatedFactOutList -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "dataset,sourceFact", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_all_entities_aggregated_facts(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_aggregated_facts: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.get_all_entities_aggregated_facts(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_aggregated_facts: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiAggregatedFactOutList**](JsonApiAggregatedFactOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_entities_analytical_dashboards** -> JsonApiAnalyticalDashboardOutList get_all_entities_analytical_dashboards(workspace_id) - -Get all Dashboards - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=permissions,origin,accessInfo,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Dashboards - api_response = api_instance.get_all_entities_analytical_dashboards(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_analytical_dashboards: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get all Dashboards - api_response = api_instance.get_all_entities_analytical_dashboards(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_analytical_dashboards: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiAnalyticalDashboardOutList**](JsonApiAnalyticalDashboardOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_entities_attribute_hierarchies** -> JsonApiAttributeHierarchyOutList get_all_entities_attribute_hierarchies(workspace_id) - -Get all Attribute Hierarchies - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_attribute_hierarchy_out_list import JsonApiAttributeHierarchyOutList -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,attributes", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Attribute Hierarchies - api_response = api_instance.get_all_entities_attribute_hierarchies(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_attribute_hierarchies: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get all Attribute Hierarchies - api_response = api_instance.get_all_entities_attribute_hierarchies(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_attribute_hierarchies: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiAttributeHierarchyOutList**](JsonApiAttributeHierarchyOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_entities_attributes** -> JsonApiAttributeOutList get_all_entities_attributes(workspace_id) - -Get all Attributes - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_attribute_out_list import JsonApiAttributeOutList -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;dataset.id==321;defaultView.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "dataset,defaultView,labels,attributeHierarchies", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Attributes - api_response = api_instance.get_all_entities_attributes(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_attributes: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get all Attributes - api_response = api_instance.get_all_entities_attributes(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_attributes: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiAttributeOutList**](JsonApiAttributeOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_entities_automations** -> JsonApiAutomationOutList get_all_entities_automations(workspace_id) - -Get all Automations - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_automation_out_list import JsonApiAutomationOutList -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Automations - api_response = api_instance.get_all_entities_automations(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_automations: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get all Automations - api_response = api_instance.get_all_entities_automations(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_automations: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiAutomationOutList**](JsonApiAutomationOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_entities_custom_application_settings** -> JsonApiCustomApplicationSettingOutList get_all_entities_custom_application_settings(workspace_id) - -Get all Custom Application Settings - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "applicationName==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Custom Application Settings - api_response = api_instance.get_all_entities_custom_application_settings(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_custom_application_settings: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get all Custom Application Settings - api_response = api_instance.get_all_entities_custom_application_settings(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_custom_application_settings: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiCustomApplicationSettingOutList**](JsonApiCustomApplicationSettingOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_entities_dashboard_plugins** -> JsonApiDashboardPluginOutList get_all_entities_dashboard_plugins(workspace_id) - -Get all Plugins - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Plugins - api_response = api_instance.get_all_entities_dashboard_plugins(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_dashboard_plugins: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get all Plugins - api_response = api_instance.get_all_entities_dashboard_plugins(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_dashboard_plugins: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiDashboardPluginOutList**](JsonApiDashboardPluginOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_entities_datasets** -> JsonApiDatasetOutList get_all_entities_datasets(workspace_id) - -Get all Datasets - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_dataset_out_list import JsonApiDatasetOutList -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "attributes,facts,aggregatedFacts,references,workspaceDataFilters", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Datasets - api_response = api_instance.get_all_entities_datasets(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_datasets: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get all Datasets - api_response = api_instance.get_all_entities_datasets(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_datasets: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiDatasetOutList**](JsonApiDatasetOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_entities_export_definitions** -> JsonApiExportDefinitionOutList get_all_entities_export_definitions(workspace_id) - -Get all Export Definitions - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_export_definition_out_list import JsonApiExportDefinitionOutList -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Export Definitions - api_response = api_instance.get_all_entities_export_definitions(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_export_definitions: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get all Export Definitions - api_response = api_instance.get_all_entities_export_definitions(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_export_definitions: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiExportDefinitionOutList**](JsonApiExportDefinitionOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_entities_facts** -> JsonApiFactOutList get_all_entities_facts(workspace_id) - -Get all Facts - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_fact_out_list import JsonApiFactOutList -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;dataset.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "dataset", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Facts - api_response = api_instance.get_all_entities_facts(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_facts: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get all Facts - api_response = api_instance.get_all_entities_facts(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_facts: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiFactOutList**](JsonApiFactOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_entities_filter_contexts** -> JsonApiFilterContextOutList get_all_entities_filter_contexts(workspace_id) - -Get all Filter Context - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_filter_context_out_list import JsonApiFilterContextOutList -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "attributes,datasets,labels", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Filter Context - api_response = api_instance.get_all_entities_filter_contexts(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_filter_contexts: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get all Filter Context - api_response = api_instance.get_all_entities_filter_contexts(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_filter_contexts: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiFilterContextOutList**](JsonApiFilterContextOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_entities_filter_views** -> JsonApiFilterViewOutList get_all_entities_filter_views(workspace_id) - -Get all Filter views - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_filter_view_out_list import JsonApiFilterViewOutList -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;analyticalDashboard.id==321;user.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "analyticalDashboard,user", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Filter views - api_response = api_instance.get_all_entities_filter_views(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_filter_views: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get all Filter views - api_response = api_instance.get_all_entities_filter_views(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_filter_views: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiFilterViewOutList**](JsonApiFilterViewOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_entities_knowledge_recommendations** -> JsonApiKnowledgeRecommendationOutList get_all_entities_knowledge_recommendations(workspace_id) - - - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_knowledge_recommendation_out_list import JsonApiKnowledgeRecommendationOutList -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "metric,analyticalDashboard", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_all_entities_knowledge_recommendations(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_knowledge_recommendations: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.get_all_entities_knowledge_recommendations(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_knowledge_recommendations: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiKnowledgeRecommendationOutList**](JsonApiKnowledgeRecommendationOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_entities_labels** -> JsonApiLabelOutList get_all_entities_labels(workspace_id) - -Get all Labels - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_label_out_list import JsonApiLabelOutList -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;attribute.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "attribute", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Labels - api_response = api_instance.get_all_entities_labels(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_labels: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get all Labels - api_response = api_instance.get_all_entities_labels(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_labels: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiLabelOutList**](JsonApiLabelOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_entities_memory_items** -> JsonApiMemoryItemOutList get_all_entities_memory_items(workspace_id) - - - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_memory_item_out_list import JsonApiMemoryItemOutList -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_all_entities_memory_items(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_memory_items: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.get_all_entities_memory_items(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_memory_items: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiMemoryItemOutList**](JsonApiMemoryItemOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_entities_metrics** -> JsonApiMetricOutList get_all_entities_metrics(workspace_id) - -Get all Metrics - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_metric_out_list import JsonApiMetricOutList -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Metrics - api_response = api_instance.get_all_entities_metrics(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_metrics: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get all Metrics - api_response = api_instance.get_all_entities_metrics(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_metrics: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiMetricOutList**](JsonApiMetricOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_entities_user_data_filters** -> JsonApiUserDataFilterOutList get_all_entities_user_data_filters(workspace_id) - -Get all User Data Filters - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;user.id==321;userGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "user,userGroup,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all User Data Filters - api_response = api_instance.get_all_entities_user_data_filters(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_user_data_filters: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get all User Data Filters - api_response = api_instance.get_all_entities_user_data_filters(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_user_data_filters: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiUserDataFilterOutList**](JsonApiUserDataFilterOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_entities_visualization_objects** -> JsonApiVisualizationObjectOutList get_all_entities_visualization_objects(workspace_id) - -Get all Visualization Objects - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Visualization Objects - api_response = api_instance.get_all_entities_visualization_objects(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_visualization_objects: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get all Visualization Objects - api_response = api_instance.get_all_entities_visualization_objects(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_visualization_objects: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiVisualizationObjectOutList**](JsonApiVisualizationObjectOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_entities_workspace_data_filter_settings** -> JsonApiWorkspaceDataFilterSettingOutList get_all_entities_workspace_data_filter_settings(workspace_id) - -Get all Settings for Workspace Data Filters - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;workspaceDataFilter.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "workspaceDataFilter", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Settings for Workspace Data Filters - api_response = api_instance.get_all_entities_workspace_data_filter_settings(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_workspace_data_filter_settings: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get all Settings for Workspace Data Filters - api_response = api_instance.get_all_entities_workspace_data_filter_settings(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_workspace_data_filter_settings: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiWorkspaceDataFilterSettingOutList**](JsonApiWorkspaceDataFilterSettingOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_entities_workspace_data_filters** -> JsonApiWorkspaceDataFilterOutList get_all_entities_workspace_data_filters(workspace_id) - -Get all Workspace Data Filters - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "filterSettings", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Workspace Data Filters - api_response = api_instance.get_all_entities_workspace_data_filters(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_workspace_data_filters: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get all Workspace Data Filters - api_response = api_instance.get_all_entities_workspace_data_filters(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_workspace_data_filters: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiWorkspaceDataFilterOutList**](JsonApiWorkspaceDataFilterOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_entities_workspace_settings** -> JsonApiWorkspaceSettingOutList get_all_entities_workspace_settings(workspace_id) - -Get all Setting for Workspaces - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Setting for Workspaces - api_response = api_instance.get_all_entities_workspace_settings(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_workspace_settings: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get all Setting for Workspaces - api_response = api_instance.get_all_entities_workspace_settings(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_all_entities_workspace_settings: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiWorkspaceSettingOutList**](JsonApiWorkspaceSettingOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_entity_aggregated_facts** -> JsonApiAggregatedFactOutDocument get_entity_aggregated_facts(workspace_id, object_id) - - - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_aggregated_fact_out_document import JsonApiAggregatedFactOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "dataset,sourceFact", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_entity_aggregated_facts(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_aggregated_facts: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.get_entity_aggregated_facts(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_aggregated_facts: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiAggregatedFactOutDocument**](JsonApiAggregatedFactOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_entity_analytical_dashboards** -> JsonApiAnalyticalDashboardOutDocument get_entity_analytical_dashboards(workspace_id, object_id) - -Get a Dashboard - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=permissions,origin,accessInfo,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Dashboard - api_response = api_instance.get_entity_analytical_dashboards(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_analytical_dashboards: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get a Dashboard - api_response = api_instance.get_entity_analytical_dashboards(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_analytical_dashboards: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiAnalyticalDashboardOutDocument**](JsonApiAnalyticalDashboardOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_entity_attribute_hierarchies** -> JsonApiAttributeHierarchyOutDocument get_entity_attribute_hierarchies(workspace_id, object_id) - -Get an Attribute Hierarchy - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,attributes", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get an Attribute Hierarchy - api_response = api_instance.get_entity_attribute_hierarchies(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_attribute_hierarchies: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get an Attribute Hierarchy - api_response = api_instance.get_entity_attribute_hierarchies(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_attribute_hierarchies: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiAttributeHierarchyOutDocument**](JsonApiAttributeHierarchyOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_entity_attributes** -> JsonApiAttributeOutDocument get_entity_attributes(workspace_id, object_id) - -Get an Attribute - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_attribute_out_document import JsonApiAttributeOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;dataset.id==321;defaultView.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "dataset,defaultView,labels,attributeHierarchies", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get an Attribute - api_response = api_instance.get_entity_attributes(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_attributes: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get an Attribute - api_response = api_instance.get_entity_attributes(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_attributes: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiAttributeOutDocument**](JsonApiAttributeOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_entity_automations** -> JsonApiAutomationOutDocument get_entity_automations(workspace_id, object_id) - -Get an Automation - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get an Automation - api_response = api_instance.get_entity_automations(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_automations: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get an Automation - api_response = api_instance.get_entity_automations(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_automations: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiAutomationOutDocument**](JsonApiAutomationOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_entity_custom_application_settings** -> JsonApiCustomApplicationSettingOutDocument get_entity_custom_application_settings(workspace_id, object_id) - -Get a Custom Application Setting - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "applicationName==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Custom Application Setting - api_response = api_instance.get_entity_custom_application_settings(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_custom_application_settings: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get a Custom Application Setting - api_response = api_instance.get_entity_custom_application_settings(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_custom_application_settings: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiCustomApplicationSettingOutDocument**](JsonApiCustomApplicationSettingOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_entity_dashboard_plugins** -> JsonApiDashboardPluginOutDocument get_entity_dashboard_plugins(workspace_id, object_id) - -Get a Plugin - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Plugin - api_response = api_instance.get_entity_dashboard_plugins(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_dashboard_plugins: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get a Plugin - api_response = api_instance.get_entity_dashboard_plugins(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_dashboard_plugins: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiDashboardPluginOutDocument**](JsonApiDashboardPluginOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_entity_datasets** -> JsonApiDatasetOutDocument get_entity_datasets(workspace_id, object_id) - -Get a Dataset - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_dataset_out_document import JsonApiDatasetOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "attributes,facts,aggregatedFacts,references,workspaceDataFilters", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Dataset - api_response = api_instance.get_entity_datasets(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_datasets: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get a Dataset - api_response = api_instance.get_entity_datasets(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_datasets: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiDatasetOutDocument**](JsonApiDatasetOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_entity_export_definitions** -> JsonApiExportDefinitionOutDocument get_entity_export_definitions(workspace_id, object_id) - -Get an Export Definition - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get an Export Definition - api_response = api_instance.get_entity_export_definitions(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_export_definitions: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get an Export Definition - api_response = api_instance.get_entity_export_definitions(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_export_definitions: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiExportDefinitionOutDocument**](JsonApiExportDefinitionOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_entity_facts** -> JsonApiFactOutDocument get_entity_facts(workspace_id, object_id) - -Get a Fact - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_fact_out_document import JsonApiFactOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;dataset.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "dataset", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Fact - api_response = api_instance.get_entity_facts(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_facts: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get a Fact - api_response = api_instance.get_entity_facts(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_facts: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiFactOutDocument**](JsonApiFactOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_entity_filter_contexts** -> JsonApiFilterContextOutDocument get_entity_filter_contexts(workspace_id, object_id) - -Get a Filter Context - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "attributes,datasets,labels", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Filter Context - api_response = api_instance.get_entity_filter_contexts(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_filter_contexts: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get a Filter Context - api_response = api_instance.get_entity_filter_contexts(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_filter_contexts: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiFilterContextOutDocument**](JsonApiFilterContextOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_entity_filter_views** -> JsonApiFilterViewOutDocument get_entity_filter_views(workspace_id, object_id) - -Get Filter view - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;analyticalDashboard.id==321;user.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "analyticalDashboard,user", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # Get Filter view - api_response = api_instance.get_entity_filter_views(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_filter_views: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get Filter view - api_response = api_instance.get_entity_filter_views(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_filter_views: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - -### Return type - -[**JsonApiFilterViewOutDocument**](JsonApiFilterViewOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_entity_knowledge_recommendations** -> JsonApiKnowledgeRecommendationOutDocument get_entity_knowledge_recommendations(workspace_id, object_id) - - - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_knowledge_recommendation_out_document import JsonApiKnowledgeRecommendationOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "metric,analyticalDashboard", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_entity_knowledge_recommendations(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_knowledge_recommendations: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.get_entity_knowledge_recommendations(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_knowledge_recommendations: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiKnowledgeRecommendationOutDocument**](JsonApiKnowledgeRecommendationOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_entity_labels** -> JsonApiLabelOutDocument get_entity_labels(workspace_id, object_id) - -Get a Label - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_label_out_document import JsonApiLabelOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;attribute.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "attribute", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Label - api_response = api_instance.get_entity_labels(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_labels: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get a Label - api_response = api_instance.get_entity_labels(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_labels: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiLabelOutDocument**](JsonApiLabelOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_entity_memory_items** -> JsonApiMemoryItemOutDocument get_entity_memory_items(workspace_id, object_id) - - - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_memory_item_out_document import JsonApiMemoryItemOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_entity_memory_items(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_memory_items: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.get_entity_memory_items(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_memory_items: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiMemoryItemOutDocument**](JsonApiMemoryItemOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_entity_metrics** -> JsonApiMetricOutDocument get_entity_metrics(workspace_id, object_id) - -Get a Metric - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Metric - api_response = api_instance.get_entity_metrics(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_metrics: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get a Metric - api_response = api_instance.get_entity_metrics(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_metrics: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiMetricOutDocument**](JsonApiMetricOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_entity_user_data_filters** -> JsonApiUserDataFilterOutDocument get_entity_user_data_filters(workspace_id, object_id) - -Get a User Data Filter - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;user.id==321;userGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "user,userGroup,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a User Data Filter - api_response = api_instance.get_entity_user_data_filters(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_user_data_filters: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get a User Data Filter - api_response = api_instance.get_entity_user_data_filters(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_user_data_filters: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiUserDataFilterOutDocument**](JsonApiUserDataFilterOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_entity_visualization_objects** -> JsonApiVisualizationObjectOutDocument get_entity_visualization_objects(workspace_id, object_id) - -Get a Visualization Object - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Visualization Object - api_response = api_instance.get_entity_visualization_objects(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_visualization_objects: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get a Visualization Object - api_response = api_instance.get_entity_visualization_objects(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_visualization_objects: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiVisualizationObjectOutDocument**](JsonApiVisualizationObjectOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_entity_workspace_data_filter_settings** -> JsonApiWorkspaceDataFilterSettingOutDocument get_entity_workspace_data_filter_settings(workspace_id, object_id) - -Get a Setting for Workspace Data Filter - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;workspaceDataFilter.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "workspaceDataFilter", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Setting for Workspace Data Filter - api_response = api_instance.get_entity_workspace_data_filter_settings(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_workspace_data_filter_settings: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get a Setting for Workspace Data Filter - api_response = api_instance.get_entity_workspace_data_filter_settings(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_workspace_data_filter_settings: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiWorkspaceDataFilterSettingOutDocument**](JsonApiWorkspaceDataFilterSettingOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_entity_workspace_data_filters** -> JsonApiWorkspaceDataFilterOutDocument get_entity_workspace_data_filters(workspace_id, object_id) - -Get a Workspace Data Filter - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "filterSettings", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Workspace Data Filter - api_response = api_instance.get_entity_workspace_data_filters(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_workspace_data_filters: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get a Workspace Data Filter - api_response = api_instance.get_entity_workspace_data_filters(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_workspace_data_filters: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiWorkspaceDataFilterOutDocument**](JsonApiWorkspaceDataFilterOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_entity_workspace_settings** -> JsonApiWorkspaceSettingOutDocument get_entity_workspace_settings(workspace_id, object_id) - -Get a Setting for Workspace - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get a Setting for Workspace - api_response = api_instance.get_entity_workspace_settings(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_workspace_settings: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get a Setting for Workspace - api_response = api_instance.get_entity_workspace_settings(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->get_entity_workspace_settings: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] - -### Return type - -[**JsonApiWorkspaceSettingOutDocument**](JsonApiWorkspaceSettingOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **patch_entity_analytical_dashboards** -> JsonApiAnalyticalDashboardOutDocument patch_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_patch_document) - -Patch a Dashboard - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_analytical_dashboard_patch_document import JsonApiAnalyticalDashboardPatchDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_analytical_dashboard_patch_document = JsonApiAnalyticalDashboardPatchDocument( - data=JsonApiAnalyticalDashboardPatch( - attributes=JsonApiAnalyticalDashboardPatchAttributes( - are_relations_valid=True, - content={}, - description="description_example", - summary="summary_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="analyticalDashboard", - ), - ) # JsonApiAnalyticalDashboardPatchDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Dashboard - api_response = api_instance.patch_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_analytical_dashboards: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Patch a Dashboard - api_response = api_instance.patch_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_patch_document, filter=filter, include=include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_analytical_dashboards: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_analytical_dashboard_patch_document** | [**JsonApiAnalyticalDashboardPatchDocument**](JsonApiAnalyticalDashboardPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - -### Return type - -[**JsonApiAnalyticalDashboardOutDocument**](JsonApiAnalyticalDashboardOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **patch_entity_attribute_hierarchies** -> JsonApiAttributeHierarchyOutDocument patch_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_patch_document) - -Patch an Attribute Hierarchy - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_attribute_hierarchy_patch_document import JsonApiAttributeHierarchyPatchDocument -from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_attribute_hierarchy_patch_document = JsonApiAttributeHierarchyPatchDocument( - data=JsonApiAttributeHierarchyPatch( - attributes=JsonApiAttributeHierarchyInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="attributeHierarchy", - ), - ) # JsonApiAttributeHierarchyPatchDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,attributes", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch an Attribute Hierarchy - api_response = api_instance.patch_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_attribute_hierarchies: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Patch an Attribute Hierarchy - api_response = api_instance.patch_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_patch_document, filter=filter, include=include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_attribute_hierarchies: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_attribute_hierarchy_patch_document** | [**JsonApiAttributeHierarchyPatchDocument**](JsonApiAttributeHierarchyPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - -### Return type - -[**JsonApiAttributeHierarchyOutDocument**](JsonApiAttributeHierarchyOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **patch_entity_attributes** -> JsonApiAttributeOutDocument patch_entity_attributes(workspace_id, object_id, json_api_attribute_patch_document) - -Patch an Attribute (beta) - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_attribute_patch_document import JsonApiAttributePatchDocument -from gooddata_api_client.model.json_api_attribute_out_document import JsonApiAttributeOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_attribute_patch_document = JsonApiAttributePatchDocument( - data=JsonApiAttributePatch( - attributes=JsonApiAttributePatchAttributes( - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiAttributePatchRelationships( - default_view=JsonApiAttributeOutRelationshipsDefaultView( - data=JsonApiLabelToOneLinkage(None), - ), - ), - type="attribute", - ), - ) # JsonApiAttributePatchDocument | - filter = "title==someString;description==someString;dataset.id==321;defaultView.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "dataset,defaultView,labels,attributeHierarchies", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch an Attribute (beta) - api_response = api_instance.patch_entity_attributes(workspace_id, object_id, json_api_attribute_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_attributes: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Patch an Attribute (beta) - api_response = api_instance.patch_entity_attributes(workspace_id, object_id, json_api_attribute_patch_document, filter=filter, include=include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_attributes: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_attribute_patch_document** | [**JsonApiAttributePatchDocument**](JsonApiAttributePatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - -### Return type - -[**JsonApiAttributeOutDocument**](JsonApiAttributeOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **patch_entity_automations** -> JsonApiAutomationOutDocument patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document) - -Patch an Automation - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument -from gooddata_api_client.model.json_api_automation_patch_document import JsonApiAutomationPatchDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_automation_patch_document = JsonApiAutomationPatchDocument( - data=JsonApiAutomationPatch( - attributes=JsonApiAutomationInAttributes( - alert=JsonApiAutomationInAttributesAlert( - condition=AlertCondition(), - execution=AlertAfm( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - interval="DAY", - trigger="ALWAYS", - ), - are_relations_valid=True, - dashboard_tabular_exports=[ - JsonApiAutomationInAttributesDashboardTabularExportsInner( - request_payload=DashboardTabularExportRequestV2( - dashboard_filters_override=[ - DashboardFilter(), - ], - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - dashboard_tabs_filters_overrides={ - "key": [ - DashboardFilter(), - ], - }, - file_name="result", - format="XLSX", - settings=DashboardExportSettings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - ), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - description="description_example", - details={}, - evaluation_mode="SHARED", - external_recipients=[ - JsonApiAutomationInAttributesExternalRecipientsInner( - email="email_example", - ), - ], - image_exports=[ - JsonApiAutomationInAttributesImageExportsInner( - request_payload=ImageExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PNG", - metadata=JsonNode(), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - metadata=JsonApiAutomationInAttributesMetadata(), - raw_exports=[ - JsonApiAutomationInAttributesRawExportsInner( - request_payload=RawExportAutomationRequest( - custom_override=RawCustomOverride( - labels={ - "key": RawCustomLabel( - title="title_example", - ), - }, - metrics={ - "key": RawCustomMetric( - title="title_example", - ), - }, - ), - delimiter="U", - execution=AFM( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measure_definition_overrides=[ - MetricDefinitionOverride( - definition=InlineMeasureDefinition( - inline=InlineMeasureDefinitionInline( - maql="maql_example", - ), - ), - item=AfmObjectIdentifierCore( - identifier=AfmObjectIdentifierCoreIdentifier( - id="sample_item.price", - type="attribute", - ), - ), - ), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - execution_settings=ExecutionSettings( - data_sampling_percentage=0, - timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), - ), - file_name="result", - format="CSV", - metadata=JsonNode(), - ), - ), - ], - schedule=JsonApiAutomationInAttributesSchedule( - cron="0 */30 9-17 ? * MON-FRI", - first_run=dateutil_parser('2025-01-01T12:00:00Z'), - timezone="Europe/Prague", - ), - slides_exports=[ - JsonApiAutomationInAttributesSlidesExportsInner( - request_payload=SlidesExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PDF", - metadata=JsonNode(), - template_id="template_id_example", - visualization_ids=[ - "visualization_ids_example", - ], - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - state="ACTIVE", - tabular_exports=[ - JsonApiAutomationInAttributesTabularExportsInner( - request_payload=TabularExportRequest( - custom_override=CustomOverride( - labels={ - "key": CustomLabel( - title="title_example", - ), - }, - metrics={ - "key": CustomMetric( - format="format_example", - title="title_example", - ), - }, - ), - execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", - file_name="result", - format="CSV", - metadata=JsonNode(), - related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - settings=Settings( - delimiter="U", - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - pdf_page_size="a4 landscape", - pdf_table_style=[ - PdfTableStyle( - properties=[ - PdfTableStyleProperty( - key="key_example", - value="value_example", - ), - ], - selector="selector_example", - ), - ], - pdf_top_left_content="Good", - pdf_top_right_content="Morning", - show_filters=False, - ), - visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", - visualization_object_custom_filters=[ - {}, - ], - ), - ), - ], - tags=[ - "tags_example", - ], - title="title_example", - visual_exports=[ - JsonApiAutomationInAttributesVisualExportsInner( - request_payload=VisualExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - metadata={}, - ), - ), - ], - ), - id="id1", - relationships=JsonApiAutomationInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - export_definitions=JsonApiAutomationInRelationshipsExportDefinitions( - data=JsonApiExportDefinitionToManyLinkage([ - JsonApiExportDefinitionLinkage( - id="id_example", - type="exportDefinition", - ), - ]), - ), - notification_channel=JsonApiAutomationInRelationshipsNotificationChannel( - data=JsonApiNotificationChannelToOneLinkage(None), - ), - recipients=JsonApiAutomationInRelationshipsRecipients( - data=JsonApiUserToManyLinkage([ - JsonApiUserLinkage( - id="id_example", - type="user", - ), - ]), - ), - ), - type="automation", - ), - ) # JsonApiAutomationPatchDocument | - filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch an Automation - api_response = api_instance.patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_automations: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Patch an Automation - api_response = api_instance.patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document, filter=filter, include=include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_automations: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_automation_patch_document** | [**JsonApiAutomationPatchDocument**](JsonApiAutomationPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - -### Return type - -[**JsonApiAutomationOutDocument**](JsonApiAutomationOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **patch_entity_custom_application_settings** -> JsonApiCustomApplicationSettingOutDocument patch_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_patch_document) - -Patch a Custom Application Setting - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_custom_application_setting_patch_document import JsonApiCustomApplicationSettingPatchDocument -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_custom_application_setting_patch_document = JsonApiCustomApplicationSettingPatchDocument( - data=JsonApiCustomApplicationSettingPatch( - attributes=JsonApiCustomApplicationSettingPatchAttributes( - application_name="application_name_example", - content={}, - ), - id="id1", - type="customApplicationSetting", - ), - ) # JsonApiCustomApplicationSettingPatchDocument | - filter = "applicationName==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Custom Application Setting - api_response = api_instance.patch_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_custom_application_settings: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Patch a Custom Application Setting - api_response = api_instance.patch_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_patch_document, filter=filter) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_custom_application_settings: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_custom_application_setting_patch_document** | [**JsonApiCustomApplicationSettingPatchDocument**](JsonApiCustomApplicationSettingPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -[**JsonApiCustomApplicationSettingOutDocument**](JsonApiCustomApplicationSettingOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **patch_entity_dashboard_plugins** -> JsonApiDashboardPluginOutDocument patch_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_patch_document) - -Patch a Plugin - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument -from gooddata_api_client.model.json_api_dashboard_plugin_patch_document import JsonApiDashboardPluginPatchDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_dashboard_plugin_patch_document = JsonApiDashboardPluginPatchDocument( - data=JsonApiDashboardPluginPatch( - attributes=JsonApiDashboardPluginInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="dashboardPlugin", - ), - ) # JsonApiDashboardPluginPatchDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Plugin - api_response = api_instance.patch_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_dashboard_plugins: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Patch a Plugin - api_response = api_instance.patch_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_patch_document, filter=filter, include=include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_dashboard_plugins: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_dashboard_plugin_patch_document** | [**JsonApiDashboardPluginPatchDocument**](JsonApiDashboardPluginPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - -### Return type - -[**JsonApiDashboardPluginOutDocument**](JsonApiDashboardPluginOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **patch_entity_datasets** -> JsonApiDatasetOutDocument patch_entity_datasets(workspace_id, object_id, json_api_dataset_patch_document) - -Patch a Dataset (beta) - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_dataset_out_document import JsonApiDatasetOutDocument -from gooddata_api_client.model.json_api_dataset_patch_document import JsonApiDatasetPatchDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_dataset_patch_document = JsonApiDatasetPatchDocument( - data=JsonApiDatasetPatch( - attributes=JsonApiAttributePatchAttributes( - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="dataset", - ), - ) # JsonApiDatasetPatchDocument | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "attributes,facts,aggregatedFacts,references,workspaceDataFilters", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Dataset (beta) - api_response = api_instance.patch_entity_datasets(workspace_id, object_id, json_api_dataset_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_datasets: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Patch a Dataset (beta) - api_response = api_instance.patch_entity_datasets(workspace_id, object_id, json_api_dataset_patch_document, filter=filter, include=include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_datasets: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_dataset_patch_document** | [**JsonApiDatasetPatchDocument**](JsonApiDatasetPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - -### Return type - -[**JsonApiDatasetOutDocument**](JsonApiDatasetOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **patch_entity_export_definitions** -> JsonApiExportDefinitionOutDocument patch_entity_export_definitions(workspace_id, object_id, json_api_export_definition_patch_document) - -Patch an Export Definition - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument -from gooddata_api_client.model.json_api_export_definition_patch_document import JsonApiExportDefinitionPatchDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_export_definition_patch_document = JsonApiExportDefinitionPatchDocument( - data=JsonApiExportDefinitionPatch( - attributes=JsonApiExportDefinitionInAttributes( - are_relations_valid=True, - description="description_example", - request_payload=JsonApiExportDefinitionInAttributesRequestPayload(), - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiExportDefinitionInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - visualization_object=JsonApiExportDefinitionInRelationshipsVisualizationObject( - data=JsonApiVisualizationObjectToOneLinkage(None), - ), - ), - type="exportDefinition", - ), - ) # JsonApiExportDefinitionPatchDocument | - filter = "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch an Export Definition - api_response = api_instance.patch_entity_export_definitions(workspace_id, object_id, json_api_export_definition_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_export_definitions: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Patch an Export Definition - api_response = api_instance.patch_entity_export_definitions(workspace_id, object_id, json_api_export_definition_patch_document, filter=filter, include=include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_export_definitions: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_export_definition_patch_document** | [**JsonApiExportDefinitionPatchDocument**](JsonApiExportDefinitionPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - -### Return type - -[**JsonApiExportDefinitionOutDocument**](JsonApiExportDefinitionOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **patch_entity_facts** -> JsonApiFactOutDocument patch_entity_facts(workspace_id, object_id, json_api_fact_patch_document) - -Patch a Fact (beta) - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_fact_out_document import JsonApiFactOutDocument -from gooddata_api_client.model.json_api_fact_patch_document import JsonApiFactPatchDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_fact_patch_document = JsonApiFactPatchDocument( - data=JsonApiFactPatch( - attributes=JsonApiAttributePatchAttributes( - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="fact", - ), - ) # JsonApiFactPatchDocument | - filter = "title==someString;description==someString;dataset.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "dataset", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Fact (beta) - api_response = api_instance.patch_entity_facts(workspace_id, object_id, json_api_fact_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_facts: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Patch a Fact (beta) - api_response = api_instance.patch_entity_facts(workspace_id, object_id, json_api_fact_patch_document, filter=filter, include=include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_facts: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_fact_patch_document** | [**JsonApiFactPatchDocument**](JsonApiFactPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - -### Return type - -[**JsonApiFactOutDocument**](JsonApiFactOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **patch_entity_filter_contexts** -> JsonApiFilterContextOutDocument patch_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_patch_document) - -Patch a Filter Context - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_filter_context_patch_document import JsonApiFilterContextPatchDocument -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_filter_context_patch_document = JsonApiFilterContextPatchDocument( - data=JsonApiFilterContextPatch( - attributes=JsonApiFilterContextPatchAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="filterContext", - ), - ) # JsonApiFilterContextPatchDocument | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "attributes,datasets,labels", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Filter Context - api_response = api_instance.patch_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_filter_contexts: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Patch a Filter Context - api_response = api_instance.patch_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_patch_document, filter=filter, include=include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_filter_contexts: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_filter_context_patch_document** | [**JsonApiFilterContextPatchDocument**](JsonApiFilterContextPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - -### Return type - -[**JsonApiFilterContextOutDocument**](JsonApiFilterContextOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **patch_entity_filter_views** -> JsonApiFilterViewOutDocument patch_entity_filter_views(workspace_id, object_id, json_api_filter_view_patch_document) - -Patch Filter view - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_filter_view_patch_document import JsonApiFilterViewPatchDocument -from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_filter_view_patch_document = JsonApiFilterViewPatchDocument( - data=JsonApiFilterViewPatch( - attributes=JsonApiFilterViewPatchAttributes( - are_relations_valid=True, - content={}, - description="description_example", - is_default=True, - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiFilterViewInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - user=JsonApiFilterViewInRelationshipsUser( - data=JsonApiUserToOneLinkage(None), - ), - ), - type="filterView", - ), - ) # JsonApiFilterViewPatchDocument | - filter = "title==someString;description==someString;analyticalDashboard.id==321;user.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "analyticalDashboard,user", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch Filter view - api_response = api_instance.patch_entity_filter_views(workspace_id, object_id, json_api_filter_view_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_filter_views: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Patch Filter view - api_response = api_instance.patch_entity_filter_views(workspace_id, object_id, json_api_filter_view_patch_document, filter=filter, include=include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_filter_views: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_filter_view_patch_document** | [**JsonApiFilterViewPatchDocument**](JsonApiFilterViewPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - -### Return type - -[**JsonApiFilterViewOutDocument**](JsonApiFilterViewOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **patch_entity_knowledge_recommendations** -> JsonApiKnowledgeRecommendationOutDocument patch_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_patch_document) - - - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_knowledge_recommendation_patch_document import JsonApiKnowledgeRecommendationPatchDocument -from gooddata_api_client.model.json_api_knowledge_recommendation_out_document import JsonApiKnowledgeRecommendationOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_knowledge_recommendation_patch_document = JsonApiKnowledgeRecommendationPatchDocument( - data=JsonApiKnowledgeRecommendationPatch( - attributes=JsonApiKnowledgeRecommendationPatchAttributes( - analytical_dashboard_title="Portfolio Health Insights", - analyzed_period="2023-07", - analyzed_value=None, - are_relations_valid=True, - comparison_type="MONTH", - confidence=None, - description="description_example", - direction="DECREASED", - metric_title="Revenue", - recommendations={}, - reference_period="2023-06", - reference_value=None, - source_count=2, - tags=[ - "tags_example", - ], - title="title_example", - widget_id="widget-123", - widget_name="Revenue Trend", - ), - id="id1", - relationships=JsonApiKnowledgeRecommendationOutRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - metric=JsonApiKnowledgeRecommendationInRelationshipsMetric( - data=JsonApiMetricToOneLinkage(None), - ), - ), - type="knowledgeRecommendation", - ), - ) # JsonApiKnowledgeRecommendationPatchDocument | - filter = "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "metric,analyticalDashboard", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.patch_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_knowledge_recommendations: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.patch_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_patch_document, filter=filter, include=include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_knowledge_recommendations: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_knowledge_recommendation_patch_document** | [**JsonApiKnowledgeRecommendationPatchDocument**](JsonApiKnowledgeRecommendationPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - -### Return type - -[**JsonApiKnowledgeRecommendationOutDocument**](JsonApiKnowledgeRecommendationOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **patch_entity_labels** -> JsonApiLabelOutDocument patch_entity_labels(workspace_id, object_id, json_api_label_patch_document) - -Patch a Label (beta) - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_label_patch_document import JsonApiLabelPatchDocument -from gooddata_api_client.model.json_api_label_out_document import JsonApiLabelOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_label_patch_document = JsonApiLabelPatchDocument( - data=JsonApiLabelPatch( - attributes=JsonApiAttributePatchAttributes( - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="label", - ), - ) # JsonApiLabelPatchDocument | - filter = "title==someString;description==someString;attribute.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "attribute", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Label (beta) - api_response = api_instance.patch_entity_labels(workspace_id, object_id, json_api_label_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_labels: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Patch a Label (beta) - api_response = api_instance.patch_entity_labels(workspace_id, object_id, json_api_label_patch_document, filter=filter, include=include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_labels: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_label_patch_document** | [**JsonApiLabelPatchDocument**](JsonApiLabelPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - -### Return type - -[**JsonApiLabelOutDocument**](JsonApiLabelOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **patch_entity_memory_items** -> JsonApiMemoryItemOutDocument patch_entity_memory_items(workspace_id, object_id, json_api_memory_item_patch_document) - - - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_memory_item_patch_document import JsonApiMemoryItemPatchDocument -from gooddata_api_client.model.json_api_memory_item_out_document import JsonApiMemoryItemOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_memory_item_patch_document = JsonApiMemoryItemPatchDocument( - data=JsonApiMemoryItemPatch( - attributes=JsonApiMemoryItemPatchAttributes( - are_relations_valid=True, - description="description_example", - instruction="instruction_example", - is_disabled=True, - keywords=[ - "keywords_example", - ], - strategy="ALWAYS", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="memoryItem", - ), - ) # JsonApiMemoryItemPatchDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.patch_entity_memory_items(workspace_id, object_id, json_api_memory_item_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_memory_items: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.patch_entity_memory_items(workspace_id, object_id, json_api_memory_item_patch_document, filter=filter, include=include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_memory_items: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_memory_item_patch_document** | [**JsonApiMemoryItemPatchDocument**](JsonApiMemoryItemPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - -### Return type - -[**JsonApiMemoryItemOutDocument**](JsonApiMemoryItemOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **patch_entity_metrics** -> JsonApiMetricOutDocument patch_entity_metrics(workspace_id, object_id, json_api_metric_patch_document) - -Patch a Metric - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_metric_patch_document import JsonApiMetricPatchDocument -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_metric_patch_document = JsonApiMetricPatchDocument( - data=JsonApiMetricPatch( - attributes=JsonApiMetricPatchAttributes( - are_relations_valid=True, - content=JsonApiMetricInAttributesContent( - format="format_example", - maql="maql_example", - metric_type="UNSPECIFIED", - ), - description="description_example", - is_hidden=True, - is_hidden_from_kda=True, - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="metric", - ), - ) # JsonApiMetricPatchDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Metric - api_response = api_instance.patch_entity_metrics(workspace_id, object_id, json_api_metric_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_metrics: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Patch a Metric - api_response = api_instance.patch_entity_metrics(workspace_id, object_id, json_api_metric_patch_document, filter=filter, include=include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_metrics: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_metric_patch_document** | [**JsonApiMetricPatchDocument**](JsonApiMetricPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - -### Return type - -[**JsonApiMetricOutDocument**](JsonApiMetricOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **patch_entity_user_data_filters** -> JsonApiUserDataFilterOutDocument patch_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_patch_document) - -Patch a User Data Filter - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument -from gooddata_api_client.model.json_api_user_data_filter_patch_document import JsonApiUserDataFilterPatchDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_user_data_filter_patch_document = JsonApiUserDataFilterPatchDocument( - data=JsonApiUserDataFilterPatch( - attributes=JsonApiUserDataFilterPatchAttributes( - are_relations_valid=True, - description="description_example", - maql="maql_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiUserDataFilterInRelationships( - user=JsonApiFilterViewInRelationshipsUser( - data=JsonApiUserToOneLinkage(None), - ), - user_group=JsonApiOrganizationOutRelationshipsBootstrapUserGroup( - data=JsonApiUserGroupToOneLinkage(None), - ), - ), - type="userDataFilter", - ), - ) # JsonApiUserDataFilterPatchDocument | - filter = "title==someString;description==someString;user.id==321;userGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "user,userGroup,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a User Data Filter - api_response = api_instance.patch_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_user_data_filters: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Patch a User Data Filter - api_response = api_instance.patch_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_patch_document, filter=filter, include=include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_user_data_filters: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_user_data_filter_patch_document** | [**JsonApiUserDataFilterPatchDocument**](JsonApiUserDataFilterPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - -### Return type - -[**JsonApiUserDataFilterOutDocument**](JsonApiUserDataFilterOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **patch_entity_visualization_objects** -> JsonApiVisualizationObjectOutDocument patch_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_patch_document) - -Patch a Visualization Object - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument -from gooddata_api_client.model.json_api_visualization_object_patch_document import JsonApiVisualizationObjectPatchDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_visualization_object_patch_document = JsonApiVisualizationObjectPatchDocument( - data=JsonApiVisualizationObjectPatch( - attributes=JsonApiVisualizationObjectPatchAttributes( - are_relations_valid=True, - content={}, - description="description_example", - is_hidden=True, - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="visualizationObject", - ), - ) # JsonApiVisualizationObjectPatchDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Visualization Object - api_response = api_instance.patch_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_visualization_objects: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Patch a Visualization Object - api_response = api_instance.patch_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_patch_document, filter=filter, include=include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_visualization_objects: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_visualization_object_patch_document** | [**JsonApiVisualizationObjectPatchDocument**](JsonApiVisualizationObjectPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - -### Return type - -[**JsonApiVisualizationObjectOutDocument**](JsonApiVisualizationObjectOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **patch_entity_workspace_data_filter_settings** -> JsonApiWorkspaceDataFilterSettingOutDocument patch_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_patch_document) - -Patch a Settings for Workspace Data Filter - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_data_filter_setting_patch_document import JsonApiWorkspaceDataFilterSettingPatchDocument -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_workspace_data_filter_setting_patch_document = JsonApiWorkspaceDataFilterSettingPatchDocument( - data=JsonApiWorkspaceDataFilterSettingPatch( - attributes=JsonApiWorkspaceDataFilterSettingInAttributes( - description="description_example", - filter_values=[ - "filter_values_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiWorkspaceDataFilterSettingInRelationships( - workspace_data_filter=JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter( - data=JsonApiWorkspaceDataFilterToOneLinkage(None), - ), - ), - type="workspaceDataFilterSetting", - ), - ) # JsonApiWorkspaceDataFilterSettingPatchDocument | - filter = "title==someString;description==someString;workspaceDataFilter.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "workspaceDataFilter", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Settings for Workspace Data Filter - api_response = api_instance.patch_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_workspace_data_filter_settings: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Patch a Settings for Workspace Data Filter - api_response = api_instance.patch_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_patch_document, filter=filter, include=include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_workspace_data_filter_settings: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_workspace_data_filter_setting_patch_document** | [**JsonApiWorkspaceDataFilterSettingPatchDocument**](JsonApiWorkspaceDataFilterSettingPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - -### Return type - -[**JsonApiWorkspaceDataFilterSettingOutDocument**](JsonApiWorkspaceDataFilterSettingOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **patch_entity_workspace_data_filters** -> JsonApiWorkspaceDataFilterOutDocument patch_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_patch_document) - -Patch a Workspace Data Filter - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_patch_document import JsonApiWorkspaceDataFilterPatchDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_workspace_data_filter_patch_document = JsonApiWorkspaceDataFilterPatchDocument( - data=JsonApiWorkspaceDataFilterPatch( - attributes=JsonApiWorkspaceDataFilterInAttributes( - column_name="column_name_example", - description="description_example", - title="title_example", - ), - id="id1", - relationships=JsonApiWorkspaceDataFilterInRelationships( - filter_settings=JsonApiWorkspaceDataFilterInRelationshipsFilterSettings( - data=JsonApiWorkspaceDataFilterSettingToManyLinkage([ - JsonApiWorkspaceDataFilterSettingLinkage( - id="id_example", - type="workspaceDataFilterSetting", - ), - ]), - ), - ), - type="workspaceDataFilter", - ), - ) # JsonApiWorkspaceDataFilterPatchDocument | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "filterSettings", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Workspace Data Filter - api_response = api_instance.patch_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_workspace_data_filters: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Patch a Workspace Data Filter - api_response = api_instance.patch_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_patch_document, filter=filter, include=include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_workspace_data_filters: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_workspace_data_filter_patch_document** | [**JsonApiWorkspaceDataFilterPatchDocument**](JsonApiWorkspaceDataFilterPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - -### Return type - -[**JsonApiWorkspaceDataFilterOutDocument**](JsonApiWorkspaceDataFilterOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **patch_entity_workspace_settings** -> JsonApiWorkspaceSettingOutDocument patch_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_patch_document) - -Patch a Setting for Workspace - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument -from gooddata_api_client.model.json_api_workspace_setting_patch_document import JsonApiWorkspaceSettingPatchDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_workspace_setting_patch_document = JsonApiWorkspaceSettingPatchDocument( - data=JsonApiWorkspaceSettingPatch( - attributes=JsonApiOrganizationSettingInAttributes( - content={}, - type="TIMEZONE", - ), - id="id1", - type="workspaceSetting", - ), - ) # JsonApiWorkspaceSettingPatchDocument | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Patch a Setting for Workspace - api_response = api_instance.patch_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_patch_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_workspace_settings: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Patch a Setting for Workspace - api_response = api_instance.patch_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_patch_document, filter=filter) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->patch_entity_workspace_settings: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_workspace_setting_patch_document** | [**JsonApiWorkspaceSettingPatchDocument**](JsonApiWorkspaceSettingPatchDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -[**JsonApiWorkspaceSettingOutDocument**](JsonApiWorkspaceSettingOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **search_entities_aggregated_facts** -> JsonApiAggregatedFactOutList search_entities_aggregated_facts(workspace_id, entity_search_body) - -Search request for AggregatedFact - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_aggregated_fact_out_list import JsonApiAggregatedFactOutList -from gooddata_api_client.model.entity_search_body import EntitySearchBody -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - entity_search_body = EntitySearchBody( - filter="filter_example", - include=[ - "include_example", - ], - meta_include=[ - "meta_include_example", - ], - page=EntitySearchPage( - index=0, - size=100, - ), - sort=[ - EntitySearchSort( - direction="ASC", - _property="_property_example", - ), - ], - ) # EntitySearchBody | Search request body with filter, pagination, and sorting options - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # Search request for AggregatedFact - api_response = api_instance.search_entities_aggregated_facts(workspace_id, entity_search_body) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_aggregated_facts: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Search request for AggregatedFact - api_response = api_instance.search_entities_aggregated_facts(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_aggregated_facts: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - -### Return type - -[**JsonApiAggregatedFactOutList**](JsonApiAggregatedFactOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **search_entities_analytical_dashboards** -> JsonApiAnalyticalDashboardOutList search_entities_analytical_dashboards(workspace_id, entity_search_body) - -Search request for AnalyticalDashboard - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList -from gooddata_api_client.model.entity_search_body import EntitySearchBody -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - entity_search_body = EntitySearchBody( - filter="filter_example", - include=[ - "include_example", - ], - meta_include=[ - "meta_include_example", - ], - page=EntitySearchPage( - index=0, - size=100, - ), - sort=[ - EntitySearchSort( - direction="ASC", - _property="_property_example", - ), - ], - ) # EntitySearchBody | Search request body with filter, pagination, and sorting options - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # Search request for AnalyticalDashboard - api_response = api_instance.search_entities_analytical_dashboards(workspace_id, entity_search_body) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_analytical_dashboards: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Search request for AnalyticalDashboard - api_response = api_instance.search_entities_analytical_dashboards(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_analytical_dashboards: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - -### Return type - -[**JsonApiAnalyticalDashboardOutList**](JsonApiAnalyticalDashboardOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **search_entities_attribute_hierarchies** -> JsonApiAttributeHierarchyOutList search_entities_attribute_hierarchies(workspace_id, entity_search_body) - -Search request for AttributeHierarchy - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_attribute_hierarchy_out_list import JsonApiAttributeHierarchyOutList -from gooddata_api_client.model.entity_search_body import EntitySearchBody -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - entity_search_body = EntitySearchBody( - filter="filter_example", - include=[ - "include_example", - ], - meta_include=[ - "meta_include_example", - ], - page=EntitySearchPage( - index=0, - size=100, - ), - sort=[ - EntitySearchSort( - direction="ASC", - _property="_property_example", - ), - ], - ) # EntitySearchBody | Search request body with filter, pagination, and sorting options - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # Search request for AttributeHierarchy - api_response = api_instance.search_entities_attribute_hierarchies(workspace_id, entity_search_body) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_attribute_hierarchies: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Search request for AttributeHierarchy - api_response = api_instance.search_entities_attribute_hierarchies(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_attribute_hierarchies: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - -### Return type - -[**JsonApiAttributeHierarchyOutList**](JsonApiAttributeHierarchyOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **search_entities_attributes** -> JsonApiAttributeOutList search_entities_attributes(workspace_id, entity_search_body) - -Search request for Attribute - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_attribute_out_list import JsonApiAttributeOutList -from gooddata_api_client.model.entity_search_body import EntitySearchBody -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - entity_search_body = EntitySearchBody( - filter="filter_example", - include=[ - "include_example", - ], - meta_include=[ - "meta_include_example", - ], - page=EntitySearchPage( - index=0, - size=100, - ), - sort=[ - EntitySearchSort( - direction="ASC", - _property="_property_example", - ), - ], - ) # EntitySearchBody | Search request body with filter, pagination, and sorting options - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # Search request for Attribute - api_response = api_instance.search_entities_attributes(workspace_id, entity_search_body) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_attributes: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Search request for Attribute - api_response = api_instance.search_entities_attributes(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_attributes: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - -### Return type - -[**JsonApiAttributeOutList**](JsonApiAttributeOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **search_entities_automation_results** -> JsonApiAutomationResultOutList search_entities_automation_results(workspace_id, entity_search_body) - -Search request for AutomationResult - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_automation_result_out_list import JsonApiAutomationResultOutList -from gooddata_api_client.model.entity_search_body import EntitySearchBody -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - entity_search_body = EntitySearchBody( - filter="filter_example", - include=[ - "include_example", - ], - meta_include=[ - "meta_include_example", - ], - page=EntitySearchPage( - index=0, - size=100, - ), - sort=[ - EntitySearchSort( - direction="ASC", - _property="_property_example", - ), - ], - ) # EntitySearchBody | Search request body with filter, pagination, and sorting options - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # Search request for AutomationResult - api_response = api_instance.search_entities_automation_results(workspace_id, entity_search_body) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_automation_results: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Search request for AutomationResult - api_response = api_instance.search_entities_automation_results(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_automation_results: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - -### Return type - -[**JsonApiAutomationResultOutList**](JsonApiAutomationResultOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **search_entities_automations** -> JsonApiAutomationOutList search_entities_automations(workspace_id, entity_search_body) - -Search request for Automation - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_automation_out_list import JsonApiAutomationOutList -from gooddata_api_client.model.entity_search_body import EntitySearchBody -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - entity_search_body = EntitySearchBody( - filter="filter_example", - include=[ - "include_example", - ], - meta_include=[ - "meta_include_example", - ], - page=EntitySearchPage( - index=0, - size=100, - ), - sort=[ - EntitySearchSort( - direction="ASC", - _property="_property_example", - ), - ], - ) # EntitySearchBody | Search request body with filter, pagination, and sorting options - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # Search request for Automation - api_response = api_instance.search_entities_automations(workspace_id, entity_search_body) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_automations: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Search request for Automation - api_response = api_instance.search_entities_automations(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_automations: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - -### Return type - -[**JsonApiAutomationOutList**](JsonApiAutomationOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **search_entities_custom_application_settings** -> JsonApiCustomApplicationSettingOutList search_entities_custom_application_settings(workspace_id, entity_search_body) - -Search request for CustomApplicationSetting - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList -from gooddata_api_client.model.entity_search_body import EntitySearchBody -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - entity_search_body = EntitySearchBody( - filter="filter_example", - include=[ - "include_example", - ], - meta_include=[ - "meta_include_example", - ], - page=EntitySearchPage( - index=0, - size=100, - ), - sort=[ - EntitySearchSort( - direction="ASC", - _property="_property_example", - ), - ], - ) # EntitySearchBody | Search request body with filter, pagination, and sorting options - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # Search request for CustomApplicationSetting - api_response = api_instance.search_entities_custom_application_settings(workspace_id, entity_search_body) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_custom_application_settings: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Search request for CustomApplicationSetting - api_response = api_instance.search_entities_custom_application_settings(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_custom_application_settings: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - -### Return type - -[**JsonApiCustomApplicationSettingOutList**](JsonApiCustomApplicationSettingOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **search_entities_dashboard_plugins** -> JsonApiDashboardPluginOutList search_entities_dashboard_plugins(workspace_id, entity_search_body) - -Search request for DashboardPlugin - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.entity_search_body import EntitySearchBody -from gooddata_api_client.model.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - entity_search_body = EntitySearchBody( - filter="filter_example", - include=[ - "include_example", - ], - meta_include=[ - "meta_include_example", - ], - page=EntitySearchPage( - index=0, - size=100, - ), - sort=[ - EntitySearchSort( - direction="ASC", - _property="_property_example", - ), - ], - ) # EntitySearchBody | Search request body with filter, pagination, and sorting options - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # Search request for DashboardPlugin - api_response = api_instance.search_entities_dashboard_plugins(workspace_id, entity_search_body) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_dashboard_plugins: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Search request for DashboardPlugin - api_response = api_instance.search_entities_dashboard_plugins(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_dashboard_plugins: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - -### Return type - -[**JsonApiDashboardPluginOutList**](JsonApiDashboardPluginOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **search_entities_datasets** -> JsonApiDatasetOutList search_entities_datasets(workspace_id, entity_search_body) - -Search request for Dataset - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_dataset_out_list import JsonApiDatasetOutList -from gooddata_api_client.model.entity_search_body import EntitySearchBody -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - entity_search_body = EntitySearchBody( - filter="filter_example", - include=[ - "include_example", - ], - meta_include=[ - "meta_include_example", - ], - page=EntitySearchPage( - index=0, - size=100, - ), - sort=[ - EntitySearchSort( - direction="ASC", - _property="_property_example", - ), - ], - ) # EntitySearchBody | Search request body with filter, pagination, and sorting options - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # Search request for Dataset - api_response = api_instance.search_entities_datasets(workspace_id, entity_search_body) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_datasets: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Search request for Dataset - api_response = api_instance.search_entities_datasets(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_datasets: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - -### Return type - -[**JsonApiDatasetOutList**](JsonApiDatasetOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **search_entities_export_definitions** -> JsonApiExportDefinitionOutList search_entities_export_definitions(workspace_id, entity_search_body) - -Search request for ExportDefinition - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_export_definition_out_list import JsonApiExportDefinitionOutList -from gooddata_api_client.model.entity_search_body import EntitySearchBody -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - entity_search_body = EntitySearchBody( - filter="filter_example", - include=[ - "include_example", - ], - meta_include=[ - "meta_include_example", - ], - page=EntitySearchPage( - index=0, - size=100, - ), - sort=[ - EntitySearchSort( - direction="ASC", - _property="_property_example", - ), - ], - ) # EntitySearchBody | Search request body with filter, pagination, and sorting options - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # Search request for ExportDefinition - api_response = api_instance.search_entities_export_definitions(workspace_id, entity_search_body) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_export_definitions: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Search request for ExportDefinition - api_response = api_instance.search_entities_export_definitions(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_export_definitions: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - -### Return type - -[**JsonApiExportDefinitionOutList**](JsonApiExportDefinitionOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **search_entities_facts** -> JsonApiFactOutList search_entities_facts(workspace_id, entity_search_body) - -Search request for Fact - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_fact_out_list import JsonApiFactOutList -from gooddata_api_client.model.entity_search_body import EntitySearchBody -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - entity_search_body = EntitySearchBody( - filter="filter_example", - include=[ - "include_example", - ], - meta_include=[ - "meta_include_example", - ], - page=EntitySearchPage( - index=0, - size=100, - ), - sort=[ - EntitySearchSort( - direction="ASC", - _property="_property_example", - ), - ], - ) # EntitySearchBody | Search request body with filter, pagination, and sorting options - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # Search request for Fact - api_response = api_instance.search_entities_facts(workspace_id, entity_search_body) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_facts: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Search request for Fact - api_response = api_instance.search_entities_facts(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_facts: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - -### Return type - -[**JsonApiFactOutList**](JsonApiFactOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **search_entities_filter_contexts** -> JsonApiFilterContextOutList search_entities_filter_contexts(workspace_id, entity_search_body) - -Search request for FilterContext - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_filter_context_out_list import JsonApiFilterContextOutList -from gooddata_api_client.model.entity_search_body import EntitySearchBody -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - entity_search_body = EntitySearchBody( - filter="filter_example", - include=[ - "include_example", - ], - meta_include=[ - "meta_include_example", - ], - page=EntitySearchPage( - index=0, - size=100, - ), - sort=[ - EntitySearchSort( - direction="ASC", - _property="_property_example", - ), - ], - ) # EntitySearchBody | Search request body with filter, pagination, and sorting options - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # Search request for FilterContext - api_response = api_instance.search_entities_filter_contexts(workspace_id, entity_search_body) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_filter_contexts: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Search request for FilterContext - api_response = api_instance.search_entities_filter_contexts(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_filter_contexts: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - -### Return type - -[**JsonApiFilterContextOutList**](JsonApiFilterContextOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **search_entities_filter_views** -> JsonApiFilterViewOutList search_entities_filter_views(workspace_id, entity_search_body) - -Search request for FilterView - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_filter_view_out_list import JsonApiFilterViewOutList -from gooddata_api_client.model.entity_search_body import EntitySearchBody -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - entity_search_body = EntitySearchBody( - filter="filter_example", - include=[ - "include_example", - ], - meta_include=[ - "meta_include_example", - ], - page=EntitySearchPage( - index=0, - size=100, - ), - sort=[ - EntitySearchSort( - direction="ASC", - _property="_property_example", - ), - ], - ) # EntitySearchBody | Search request body with filter, pagination, and sorting options - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # Search request for FilterView - api_response = api_instance.search_entities_filter_views(workspace_id, entity_search_body) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_filter_views: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Search request for FilterView - api_response = api_instance.search_entities_filter_views(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_filter_views: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - -### Return type - -[**JsonApiFilterViewOutList**](JsonApiFilterViewOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **search_entities_knowledge_recommendations** -> JsonApiKnowledgeRecommendationOutList search_entities_knowledge_recommendations(workspace_id, entity_search_body) - - - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_knowledge_recommendation_out_list import JsonApiKnowledgeRecommendationOutList -from gooddata_api_client.model.entity_search_body import EntitySearchBody -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - entity_search_body = EntitySearchBody( - filter="filter_example", - include=[ - "include_example", - ], - meta_include=[ - "meta_include_example", - ], - page=EntitySearchPage( - index=0, - size=100, - ), - sort=[ - EntitySearchSort( - direction="ASC", - _property="_property_example", - ), - ], - ) # EntitySearchBody | Search request body with filter, pagination, and sorting options - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.search_entities_knowledge_recommendations(workspace_id, entity_search_body) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_knowledge_recommendations: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.search_entities_knowledge_recommendations(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_knowledge_recommendations: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - -### Return type - -[**JsonApiKnowledgeRecommendationOutList**](JsonApiKnowledgeRecommendationOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **search_entities_labels** -> JsonApiLabelOutList search_entities_labels(workspace_id, entity_search_body) - -Search request for Label - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_label_out_list import JsonApiLabelOutList -from gooddata_api_client.model.entity_search_body import EntitySearchBody -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - entity_search_body = EntitySearchBody( - filter="filter_example", - include=[ - "include_example", - ], - meta_include=[ - "meta_include_example", - ], - page=EntitySearchPage( - index=0, - size=100, - ), - sort=[ - EntitySearchSort( - direction="ASC", - _property="_property_example", - ), - ], - ) # EntitySearchBody | Search request body with filter, pagination, and sorting options - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # Search request for Label - api_response = api_instance.search_entities_labels(workspace_id, entity_search_body) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_labels: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Search request for Label - api_response = api_instance.search_entities_labels(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_labels: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - -### Return type - -[**JsonApiLabelOutList**](JsonApiLabelOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **search_entities_memory_items** -> JsonApiMemoryItemOutList search_entities_memory_items(workspace_id, entity_search_body) - -Search request for MemoryItem - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_memory_item_out_list import JsonApiMemoryItemOutList -from gooddata_api_client.model.entity_search_body import EntitySearchBody -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - entity_search_body = EntitySearchBody( - filter="filter_example", - include=[ - "include_example", - ], - meta_include=[ - "meta_include_example", - ], - page=EntitySearchPage( - index=0, - size=100, - ), - sort=[ - EntitySearchSort( - direction="ASC", - _property="_property_example", - ), - ], - ) # EntitySearchBody | Search request body with filter, pagination, and sorting options - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # Search request for MemoryItem - api_response = api_instance.search_entities_memory_items(workspace_id, entity_search_body) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_memory_items: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Search request for MemoryItem - api_response = api_instance.search_entities_memory_items(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_memory_items: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - -### Return type - -[**JsonApiMemoryItemOutList**](JsonApiMemoryItemOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **search_entities_metrics** -> JsonApiMetricOutList search_entities_metrics(workspace_id, entity_search_body) - -Search request for Metric - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_metric_out_list import JsonApiMetricOutList -from gooddata_api_client.model.entity_search_body import EntitySearchBody -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - entity_search_body = EntitySearchBody( - filter="filter_example", - include=[ - "include_example", - ], - meta_include=[ - "meta_include_example", - ], - page=EntitySearchPage( - index=0, - size=100, - ), - sort=[ - EntitySearchSort( - direction="ASC", - _property="_property_example", - ), - ], - ) # EntitySearchBody | Search request body with filter, pagination, and sorting options - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # Search request for Metric - api_response = api_instance.search_entities_metrics(workspace_id, entity_search_body) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_metrics: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Search request for Metric - api_response = api_instance.search_entities_metrics(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_metrics: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - -### Return type - -[**JsonApiMetricOutList**](JsonApiMetricOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **search_entities_user_data_filters** -> JsonApiUserDataFilterOutList search_entities_user_data_filters(workspace_id, entity_search_body) - -Search request for UserDataFilter - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList -from gooddata_api_client.model.entity_search_body import EntitySearchBody -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - entity_search_body = EntitySearchBody( - filter="filter_example", - include=[ - "include_example", - ], - meta_include=[ - "meta_include_example", - ], - page=EntitySearchPage( - index=0, - size=100, - ), - sort=[ - EntitySearchSort( - direction="ASC", - _property="_property_example", - ), - ], - ) # EntitySearchBody | Search request body with filter, pagination, and sorting options - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # Search request for UserDataFilter - api_response = api_instance.search_entities_user_data_filters(workspace_id, entity_search_body) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_user_data_filters: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Search request for UserDataFilter - api_response = api_instance.search_entities_user_data_filters(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_user_data_filters: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - -### Return type - -[**JsonApiUserDataFilterOutList**](JsonApiUserDataFilterOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **search_entities_visualization_objects** -> JsonApiVisualizationObjectOutList search_entities_visualization_objects(workspace_id, entity_search_body) - -Search request for VisualizationObject - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList -from gooddata_api_client.model.entity_search_body import EntitySearchBody -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - entity_search_body = EntitySearchBody( - filter="filter_example", - include=[ - "include_example", - ], - meta_include=[ - "meta_include_example", - ], - page=EntitySearchPage( - index=0, - size=100, - ), - sort=[ - EntitySearchSort( - direction="ASC", - _property="_property_example", - ), - ], - ) # EntitySearchBody | Search request body with filter, pagination, and sorting options - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # Search request for VisualizationObject - api_response = api_instance.search_entities_visualization_objects(workspace_id, entity_search_body) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_visualization_objects: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Search request for VisualizationObject - api_response = api_instance.search_entities_visualization_objects(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_visualization_objects: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - -### Return type - -[**JsonApiVisualizationObjectOutList**](JsonApiVisualizationObjectOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **search_entities_workspace_data_filter_settings** -> JsonApiWorkspaceDataFilterSettingOutList search_entities_workspace_data_filter_settings(workspace_id, entity_search_body) - -Search request for WorkspaceDataFilterSetting - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList -from gooddata_api_client.model.entity_search_body import EntitySearchBody -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - entity_search_body = EntitySearchBody( - filter="filter_example", - include=[ - "include_example", - ], - meta_include=[ - "meta_include_example", - ], - page=EntitySearchPage( - index=0, - size=100, - ), - sort=[ - EntitySearchSort( - direction="ASC", - _property="_property_example", - ), - ], - ) # EntitySearchBody | Search request body with filter, pagination, and sorting options - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # Search request for WorkspaceDataFilterSetting - api_response = api_instance.search_entities_workspace_data_filter_settings(workspace_id, entity_search_body) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_workspace_data_filter_settings: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Search request for WorkspaceDataFilterSetting - api_response = api_instance.search_entities_workspace_data_filter_settings(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_workspace_data_filter_settings: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - -### Return type - -[**JsonApiWorkspaceDataFilterSettingOutList**](JsonApiWorkspaceDataFilterSettingOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **search_entities_workspace_data_filters** -> JsonApiWorkspaceDataFilterOutList search_entities_workspace_data_filters(workspace_id, entity_search_body) - -Search request for WorkspaceDataFilter - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList -from gooddata_api_client.model.entity_search_body import EntitySearchBody -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - entity_search_body = EntitySearchBody( - filter="filter_example", - include=[ - "include_example", - ], - meta_include=[ - "meta_include_example", - ], - page=EntitySearchPage( - index=0, - size=100, - ), - sort=[ - EntitySearchSort( - direction="ASC", - _property="_property_example", - ), - ], - ) # EntitySearchBody | Search request body with filter, pagination, and sorting options - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # Search request for WorkspaceDataFilter - api_response = api_instance.search_entities_workspace_data_filters(workspace_id, entity_search_body) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_workspace_data_filters: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Search request for WorkspaceDataFilter - api_response = api_instance.search_entities_workspace_data_filters(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_workspace_data_filters: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - -### Return type - -[**JsonApiWorkspaceDataFilterOutList**](JsonApiWorkspaceDataFilterOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **search_entities_workspace_settings** -> JsonApiWorkspaceSettingOutList search_entities_workspace_settings(workspace_id, entity_search_body) - - - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList -from gooddata_api_client.model.entity_search_body import EntitySearchBody -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - entity_search_body = EntitySearchBody( - filter="filter_example", - include=[ - "include_example", - ], - meta_include=[ - "meta_include_example", - ], - page=EntitySearchPage( - index=0, - size=100, - ), - sort=[ - EntitySearchSort( - direction="ASC", - _property="_property_example", - ), - ], - ) # EntitySearchBody | Search request body with filter, pagination, and sorting options - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.search_entities_workspace_settings(workspace_id, entity_search_body) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_workspace_settings: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.search_entities_workspace_settings(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->search_entities_workspace_settings: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - -### Return type - -[**JsonApiWorkspaceSettingOutList**](JsonApiWorkspaceSettingOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_entity_analytical_dashboards** -> JsonApiAnalyticalDashboardOutDocument update_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_in_document) - -Put Dashboards - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_analytical_dashboard_in_document import JsonApiAnalyticalDashboardInDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_analytical_dashboard_in_document = JsonApiAnalyticalDashboardInDocument( - data=JsonApiAnalyticalDashboardIn( - attributes=JsonApiAnalyticalDashboardInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - summary="summary_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="analyticalDashboard", - ), - ) # JsonApiAnalyticalDashboardInDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put Dashboards - api_response = api_instance.update_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_analytical_dashboards: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Put Dashboards - api_response = api_instance.update_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_in_document, filter=filter, include=include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_analytical_dashboards: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_analytical_dashboard_in_document** | [**JsonApiAnalyticalDashboardInDocument**](JsonApiAnalyticalDashboardInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - -### Return type - -[**JsonApiAnalyticalDashboardOutDocument**](JsonApiAnalyticalDashboardOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_entity_attribute_hierarchies** -> JsonApiAttributeHierarchyOutDocument update_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_in_document) - -Put an Attribute Hierarchy - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_attribute_hierarchy_in_document import JsonApiAttributeHierarchyInDocument -from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_attribute_hierarchy_in_document = JsonApiAttributeHierarchyInDocument( - data=JsonApiAttributeHierarchyIn( - attributes=JsonApiAttributeHierarchyInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="attributeHierarchy", - ), - ) # JsonApiAttributeHierarchyInDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,attributes", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put an Attribute Hierarchy - api_response = api_instance.update_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_attribute_hierarchies: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Put an Attribute Hierarchy - api_response = api_instance.update_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_in_document, filter=filter, include=include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_attribute_hierarchies: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_attribute_hierarchy_in_document** | [**JsonApiAttributeHierarchyInDocument**](JsonApiAttributeHierarchyInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - -### Return type - -[**JsonApiAttributeHierarchyOutDocument**](JsonApiAttributeHierarchyOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_entity_automations** -> JsonApiAutomationOutDocument update_entity_automations(workspace_id, object_id, json_api_automation_in_document) - -Put an Automation - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_automation_in_document import JsonApiAutomationInDocument -from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_automation_in_document = JsonApiAutomationInDocument( - data=JsonApiAutomationIn( - attributes=JsonApiAutomationInAttributes( - alert=JsonApiAutomationInAttributesAlert( - condition=AlertCondition(), - execution=AlertAfm( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - interval="DAY", - trigger="ALWAYS", - ), - are_relations_valid=True, - dashboard_tabular_exports=[ - JsonApiAutomationInAttributesDashboardTabularExportsInner( - request_payload=DashboardTabularExportRequestV2( - dashboard_filters_override=[ - DashboardFilter(), - ], - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - dashboard_tabs_filters_overrides={ - "key": [ - DashboardFilter(), - ], - }, - file_name="result", - format="XLSX", - settings=DashboardExportSettings( - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - ), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - description="description_example", - details={}, - evaluation_mode="SHARED", - external_recipients=[ - JsonApiAutomationInAttributesExternalRecipientsInner( - email="email_example", - ), - ], - image_exports=[ - JsonApiAutomationInAttributesImageExportsInner( - request_payload=ImageExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PNG", - metadata=JsonNode(), - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - metadata=JsonApiAutomationInAttributesMetadata(), - raw_exports=[ - JsonApiAutomationInAttributesRawExportsInner( - request_payload=RawExportAutomationRequest( - custom_override=RawCustomOverride( - labels={ - "key": RawCustomLabel( - title="title_example", - ), - }, - metrics={ - "key": RawCustomMetric( - title="title_example", - ), - }, - ), - delimiter="U", - execution=AFM( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", - type="label", - ), - ), - local_identifier="attribute_1", - show_all_values=False, - ), - ], - aux_measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - filters=[ - FilterDefinition(), - ], - measure_definition_overrides=[ - MetricDefinitionOverride( - definition=InlineMeasureDefinition( - inline=InlineMeasureDefinitionInline( - maql="maql_example", - ), - ), - item=AfmObjectIdentifierCore( - identifier=AfmObjectIdentifierCoreIdentifier( - id="sample_item.price", - type="attribute", - ), - ), - ), - ], - measures=[ - MeasureItem( - definition=MeasureDefinition(), - local_identifier="metric_1", - ), - ], - ), - execution_settings=ExecutionSettings( - data_sampling_percentage=0, - timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), - ), - file_name="result", - format="CSV", - metadata=JsonNode(), - ), - ), - ], - schedule=JsonApiAutomationInAttributesSchedule( - cron="0 */30 9-17 ? * MON-FRI", - first_run=dateutil_parser('2025-01-01T12:00:00Z'), - timezone="Europe/Prague", - ), - slides_exports=[ - JsonApiAutomationInAttributesSlidesExportsInner( - request_payload=SlidesExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PDF", - metadata=JsonNode(), - template_id="template_id_example", - visualization_ids=[ - "visualization_ids_example", - ], - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - state="ACTIVE", - tabular_exports=[ - JsonApiAutomationInAttributesTabularExportsInner( - request_payload=TabularExportRequest( - custom_override=CustomOverride( - labels={ - "key": CustomLabel( - title="title_example", - ), - }, - metrics={ - "key": CustomMetric( - format="format_example", - title="title_example", - ), - }, - ), - execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", - file_name="result", - format="CSV", - metadata=JsonNode(), - related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - settings=Settings( - delimiter="U", - export_info=True, - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - pdf_page_size="a4 landscape", - pdf_table_style=[ - PdfTableStyle( - properties=[ - PdfTableStyleProperty( - key="key_example", - value="value_example", - ), - ], - selector="selector_example", - ), - ], - pdf_top_left_content="Good", - pdf_top_right_content="Morning", - show_filters=False, - ), - visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", - visualization_object_custom_filters=[ - {}, - ], - ), - ), - ], - tags=[ - "tags_example", - ], - title="title_example", - visual_exports=[ - JsonApiAutomationInAttributesVisualExportsInner( - request_payload=VisualExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - metadata={}, - ), - ), - ], - ), - id="id1", - relationships=JsonApiAutomationInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - export_definitions=JsonApiAutomationInRelationshipsExportDefinitions( - data=JsonApiExportDefinitionToManyLinkage([ - JsonApiExportDefinitionLinkage( - id="id_example", - type="exportDefinition", - ), - ]), - ), - notification_channel=JsonApiAutomationInRelationshipsNotificationChannel( - data=JsonApiNotificationChannelToOneLinkage(None), - ), - recipients=JsonApiAutomationInRelationshipsRecipients( - data=JsonApiUserToManyLinkage([ - JsonApiUserLinkage( - id="id_example", - type="user", - ), - ]), - ), - ), - type="automation", - ), - ) # JsonApiAutomationInDocument | - filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put an Automation - api_response = api_instance.update_entity_automations(workspace_id, object_id, json_api_automation_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_automations: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Put an Automation - api_response = api_instance.update_entity_automations(workspace_id, object_id, json_api_automation_in_document, filter=filter, include=include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_automations: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_automation_in_document** | [**JsonApiAutomationInDocument**](JsonApiAutomationInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - -### Return type - -[**JsonApiAutomationOutDocument**](JsonApiAutomationOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_entity_custom_application_settings** -> JsonApiCustomApplicationSettingOutDocument update_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_in_document) - -Put a Custom Application Setting - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_custom_application_setting_in_document import JsonApiCustomApplicationSettingInDocument -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_custom_application_setting_in_document = JsonApiCustomApplicationSettingInDocument( - data=JsonApiCustomApplicationSettingIn( - attributes=JsonApiCustomApplicationSettingInAttributes( - application_name="application_name_example", - content={}, - ), - id="id1", - type="customApplicationSetting", - ), - ) # JsonApiCustomApplicationSettingInDocument | - filter = "applicationName==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Put a Custom Application Setting - api_response = api_instance.update_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_custom_application_settings: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Put a Custom Application Setting - api_response = api_instance.update_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_in_document, filter=filter) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_custom_application_settings: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_custom_application_setting_in_document** | [**JsonApiCustomApplicationSettingInDocument**](JsonApiCustomApplicationSettingInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - -### Return type - -[**JsonApiCustomApplicationSettingOutDocument**](JsonApiCustomApplicationSettingOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_entity_dashboard_plugins** -> JsonApiDashboardPluginOutDocument update_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_in_document) - -Put a Plugin - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument -from gooddata_api_client.model.json_api_dashboard_plugin_in_document import JsonApiDashboardPluginInDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_dashboard_plugin_in_document = JsonApiDashboardPluginInDocument( - data=JsonApiDashboardPluginIn( - attributes=JsonApiDashboardPluginInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="dashboardPlugin", - ), - ) # JsonApiDashboardPluginInDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put a Plugin - api_response = api_instance.update_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_dashboard_plugins: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Put a Plugin - api_response = api_instance.update_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_in_document, filter=filter, include=include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_dashboard_plugins: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_dashboard_plugin_in_document** | [**JsonApiDashboardPluginInDocument**](JsonApiDashboardPluginInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - -### Return type - -[**JsonApiDashboardPluginOutDocument**](JsonApiDashboardPluginOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_entity_export_definitions** -> JsonApiExportDefinitionOutDocument update_entity_export_definitions(workspace_id, object_id, json_api_export_definition_in_document) - -Put an Export Definition - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument -from gooddata_api_client.model.json_api_export_definition_in_document import JsonApiExportDefinitionInDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_export_definition_in_document = JsonApiExportDefinitionInDocument( - data=JsonApiExportDefinitionIn( - attributes=JsonApiExportDefinitionInAttributes( - are_relations_valid=True, - description="description_example", - request_payload=JsonApiExportDefinitionInAttributesRequestPayload(), - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiExportDefinitionInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - visualization_object=JsonApiExportDefinitionInRelationshipsVisualizationObject( - data=JsonApiVisualizationObjectToOneLinkage(None), - ), - ), - type="exportDefinition", - ), - ) # JsonApiExportDefinitionInDocument | - filter = "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put an Export Definition - api_response = api_instance.update_entity_export_definitions(workspace_id, object_id, json_api_export_definition_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_export_definitions: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Put an Export Definition - api_response = api_instance.update_entity_export_definitions(workspace_id, object_id, json_api_export_definition_in_document, filter=filter, include=include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_export_definitions: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_export_definition_in_document** | [**JsonApiExportDefinitionInDocument**](JsonApiExportDefinitionInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - -### Return type - -[**JsonApiExportDefinitionOutDocument**](JsonApiExportDefinitionOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_entity_filter_contexts** -> JsonApiFilterContextOutDocument update_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_in_document) - -Put a Filter Context - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_filter_context_in_document import JsonApiFilterContextInDocument -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_filter_context_in_document = JsonApiFilterContextInDocument( - data=JsonApiFilterContextIn( - attributes=JsonApiFilterContextInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="filterContext", - ), - ) # JsonApiFilterContextInDocument | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "attributes,datasets,labels", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put a Filter Context - api_response = api_instance.update_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_filter_contexts: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Put a Filter Context - api_response = api_instance.update_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_in_document, filter=filter, include=include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_filter_contexts: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_filter_context_in_document** | [**JsonApiFilterContextInDocument**](JsonApiFilterContextInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - -### Return type - -[**JsonApiFilterContextOutDocument**](JsonApiFilterContextOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_entity_filter_views** -> JsonApiFilterViewOutDocument update_entity_filter_views(workspace_id, object_id, json_api_filter_view_in_document) - -Put Filter views - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_filter_view_in_document import JsonApiFilterViewInDocument -from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_filter_view_in_document = JsonApiFilterViewInDocument( - data=JsonApiFilterViewIn( - attributes=JsonApiFilterViewInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - is_default=True, - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiFilterViewInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - user=JsonApiFilterViewInRelationshipsUser( - data=JsonApiUserToOneLinkage(None), - ), - ), - type="filterView", - ), - ) # JsonApiFilterViewInDocument | - filter = "title==someString;description==someString;analyticalDashboard.id==321;user.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "analyticalDashboard,user", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Put Filter views - api_response = api_instance.update_entity_filter_views(workspace_id, object_id, json_api_filter_view_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_filter_views: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Put Filter views - api_response = api_instance.update_entity_filter_views(workspace_id, object_id, json_api_filter_view_in_document, filter=filter, include=include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_filter_views: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_filter_view_in_document** | [**JsonApiFilterViewInDocument**](JsonApiFilterViewInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - -### Return type - -[**JsonApiFilterViewOutDocument**](JsonApiFilterViewOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_entity_knowledge_recommendations** -> JsonApiKnowledgeRecommendationOutDocument update_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_in_document) - - - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_knowledge_recommendation_out_document import JsonApiKnowledgeRecommendationOutDocument -from gooddata_api_client.model.json_api_knowledge_recommendation_in_document import JsonApiKnowledgeRecommendationInDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_knowledge_recommendation_in_document = JsonApiKnowledgeRecommendationInDocument( - data=JsonApiKnowledgeRecommendationIn( - attributes=JsonApiKnowledgeRecommendationInAttributes( - analytical_dashboard_title="Portfolio Health Insights", - analyzed_period="2023-07", - analyzed_value=None, - are_relations_valid=True, - comparison_type="MONTH", - confidence=None, - description="description_example", - direction="DECREASED", - metric_title="Revenue", - recommendations={}, - reference_period="2023-06", - reference_value=None, - source_count=2, - tags=[ - "tags_example", - ], - title="title_example", - widget_id="widget-123", - widget_name="Revenue Trend", - ), - id="id1", - relationships=JsonApiKnowledgeRecommendationInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - metric=JsonApiKnowledgeRecommendationInRelationshipsMetric( - data=JsonApiMetricToOneLinkage(None), - ), - ), - type="knowledgeRecommendation", - ), - ) # JsonApiKnowledgeRecommendationInDocument | - filter = "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "metric,analyticalDashboard", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.update_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_knowledge_recommendations: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.update_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_in_document, filter=filter, include=include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_knowledge_recommendations: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_knowledge_recommendation_in_document** | [**JsonApiKnowledgeRecommendationInDocument**](JsonApiKnowledgeRecommendationInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - -### Return type - -[**JsonApiKnowledgeRecommendationOutDocument**](JsonApiKnowledgeRecommendationOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_entity_memory_items** -> JsonApiMemoryItemOutDocument update_entity_memory_items(workspace_id, object_id, json_api_memory_item_in_document) - - - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_memory_item_in_document import JsonApiMemoryItemInDocument -from gooddata_api_client.model.json_api_memory_item_out_document import JsonApiMemoryItemOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_memory_item_in_document = JsonApiMemoryItemInDocument( - data=JsonApiMemoryItemIn( - attributes=JsonApiMemoryItemInAttributes( - are_relations_valid=True, - description="description_example", - instruction="instruction_example", - is_disabled=True, - keywords=[ - "keywords_example", - ], - strategy="ALWAYS", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="memoryItem", - ), - ) # JsonApiMemoryItemInDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.update_entity_memory_items(workspace_id, object_id, json_api_memory_item_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_memory_items: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.update_entity_memory_items(workspace_id, object_id, json_api_memory_item_in_document, filter=filter, include=include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_memory_items: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_memory_item_in_document** | [**JsonApiMemoryItemInDocument**](JsonApiMemoryItemInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - -### Return type - -[**JsonApiMemoryItemOutDocument**](JsonApiMemoryItemOutDocument.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.gooddata.api+json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_entity_metrics** -> JsonApiMetricOutDocument update_entity_metrics(workspace_id, object_id, json_api_metric_in_document) - -Put a Metric - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_metric_in_document import JsonApiMetricInDocument -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument -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 = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_metric_in_document = JsonApiMetricInDocument( - data=JsonApiMetricIn( - attributes=JsonApiMetricInAttributes( - are_relations_valid=True, - content=JsonApiMetricInAttributesContent( - format="format_example", - maql="maql_example", - metric_type="UNSPECIFIED", - ), - description="description_example", - is_hidden=True, - is_hidden_from_kda=True, - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="metric", + entity_search_body = EntitySearchBody( + filter="filter_example", + include=[ + "include_example", + ], + meta_include=[ + "meta_include_example", + ], + page=EntitySearchPage( + index=0, + size=100, ), - ) # JsonApiMetricInDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + sort=[ + EntitySearchSort( + direction="ASC", + _property="_property_example", + ), + ], + ) # EntitySearchBody | Search request body with filter, pagination, and sorting options + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False # example passing only required values which don't have defaults set try: - # Put a Metric - api_response = api_instance.update_entity_metrics(workspace_id, object_id, json_api_metric_in_document) + # Search request for AggregatedFact + api_response = api_instance.search_entities_aggregated_facts(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_metrics: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->search_entities_aggregated_facts: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Put a Metric - api_response = api_instance.update_entity_metrics(workspace_id, object_id, json_api_metric_in_document, filter=filter, include=include) + # Search request for AggregatedFact + api_response = api_instance.search_entities_aggregated_facts(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_metrics: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->search_entities_aggregated_facts: %s\n" % e) ``` @@ -12853,14 +1221,13 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_metric_in_document** | [**JsonApiMetricInDocument**](JsonApiMetricInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False ### Return type -[**JsonApiMetricOutDocument**](JsonApiMetricOutDocument.md) +[**JsonApiAggregatedFactOutList**](JsonApiAggregatedFactOutList.md) ### Authorization @@ -12868,7 +1235,7 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Content-Type**: application/json - **Accept**: application/json, application/vnd.gooddata.api+json @@ -12880,10 +1247,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **update_entity_user_data_filters** -> JsonApiUserDataFilterOutDocument update_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_in_document) +# **search_entities_automation_results** +> JsonApiAutomationResultOutList search_entities_automation_results(workspace_id, entity_search_body) -Put a User Data Filter +Search request for AutomationResult ### Example @@ -12892,8 +1259,8 @@ Put a User Data Filter import time import gooddata_api_client from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument -from gooddata_api_client.model.json_api_user_data_filter_in_document import JsonApiUserDataFilterInDocument +from gooddata_api_client.model.json_api_automation_result_out_list import JsonApiAutomationResultOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody 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. @@ -12907,51 +1274,44 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_user_data_filter_in_document = JsonApiUserDataFilterInDocument( - data=JsonApiUserDataFilterIn( - attributes=JsonApiUserDataFilterInAttributes( - are_relations_valid=True, - description="description_example", - maql="maql_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiUserDataFilterInRelationships( - user=JsonApiFilterViewInRelationshipsUser( - data=JsonApiUserToOneLinkage(None), - ), - user_group=JsonApiOrganizationOutRelationshipsBootstrapUserGroup( - data=JsonApiUserGroupToOneLinkage(None), - ), - ), - type="userDataFilter", + entity_search_body = EntitySearchBody( + filter="filter_example", + include=[ + "include_example", + ], + meta_include=[ + "meta_include_example", + ], + page=EntitySearchPage( + index=0, + size=100, ), - ) # JsonApiUserDataFilterInDocument | - filter = "title==someString;description==someString;user.id==321;userGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "user,userGroup,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + sort=[ + EntitySearchSort( + direction="ASC", + _property="_property_example", + ), + ], + ) # EntitySearchBody | Search request body with filter, pagination, and sorting options + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False # example passing only required values which don't have defaults set try: - # Put a User Data Filter - api_response = api_instance.update_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_in_document) + # Search request for AutomationResult + api_response = api_instance.search_entities_automation_results(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_user_data_filters: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->search_entities_automation_results: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Put a User Data Filter - api_response = api_instance.update_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_in_document, filter=filter, include=include) + # Search request for AutomationResult + api_response = api_instance.search_entities_automation_results(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_user_data_filters: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->search_entities_automation_results: %s\n" % e) ``` @@ -12960,14 +1320,13 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_user_data_filter_in_document** | [**JsonApiUserDataFilterInDocument**](JsonApiUserDataFilterInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False ### Return type -[**JsonApiUserDataFilterOutDocument**](JsonApiUserDataFilterOutDocument.md) +[**JsonApiAutomationResultOutList**](JsonApiAutomationResultOutList.md) ### Authorization @@ -12975,7 +1334,7 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Content-Type**: application/json - **Accept**: application/json, application/vnd.gooddata.api+json @@ -12987,10 +1346,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **update_entity_visualization_objects** -> JsonApiVisualizationObjectOutDocument update_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_in_document) +# **search_entities_knowledge_recommendations** +> JsonApiKnowledgeRecommendationOutList search_entities_knowledge_recommendations(workspace_id, entity_search_body) -Put a Visualization Object +The search endpoint (beta) ### Example @@ -12999,8 +1358,8 @@ Put a Visualization Object import time import gooddata_api_client from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument -from gooddata_api_client.model.json_api_visualization_object_in_document import JsonApiVisualizationObjectInDocument +from gooddata_api_client.model.json_api_knowledge_recommendation_out_list import JsonApiKnowledgeRecommendationOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody 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. @@ -13014,44 +1373,44 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_visualization_object_in_document = JsonApiVisualizationObjectInDocument( - data=JsonApiVisualizationObjectIn( - attributes=JsonApiVisualizationObjectInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - is_hidden=True, - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="visualizationObject", + entity_search_body = EntitySearchBody( + filter="filter_example", + include=[ + "include_example", + ], + meta_include=[ + "meta_include_example", + ], + page=EntitySearchPage( + index=0, + size=100, ), - ) # JsonApiVisualizationObjectInDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + sort=[ + EntitySearchSort( + direction="ASC", + _property="_property_example", + ), + ], + ) # EntitySearchBody | Search request body with filter, pagination, and sorting options + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False # example passing only required values which don't have defaults set try: - # Put a Visualization Object - api_response = api_instance.update_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_in_document) + # The search endpoint (beta) + api_response = api_instance.search_entities_knowledge_recommendations(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_visualization_objects: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->search_entities_knowledge_recommendations: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Put a Visualization Object - api_response = api_instance.update_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_in_document, filter=filter, include=include) + # The search endpoint (beta) + api_response = api_instance.search_entities_knowledge_recommendations(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_visualization_objects: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->search_entities_knowledge_recommendations: %s\n" % e) ``` @@ -13060,14 +1419,13 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_visualization_object_in_document** | [**JsonApiVisualizationObjectInDocument**](JsonApiVisualizationObjectInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False ### Return type -[**JsonApiVisualizationObjectOutDocument**](JsonApiVisualizationObjectOutDocument.md) +[**JsonApiKnowledgeRecommendationOutList**](JsonApiKnowledgeRecommendationOutList.md) ### Authorization @@ -13075,7 +1433,7 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Content-Type**: application/json - **Accept**: application/json, application/vnd.gooddata.api+json @@ -13087,10 +1445,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **update_entity_workspace_data_filter_settings** -> JsonApiWorkspaceDataFilterSettingOutDocument update_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_in_document) +# **search_entities_memory_items** +> JsonApiMemoryItemOutList search_entities_memory_items(workspace_id, entity_search_body) -Put a Settings for Workspace Data Filter +Search request for MemoryItem ### Example @@ -13099,8 +1457,8 @@ Put a Settings for Workspace Data Filter import time import gooddata_api_client from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_data_filter_setting_in_document import JsonApiWorkspaceDataFilterSettingInDocument -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.model.json_api_memory_item_out_list import JsonApiMemoryItemOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody 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. @@ -13114,46 +1472,44 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_workspace_data_filter_setting_in_document = JsonApiWorkspaceDataFilterSettingInDocument( - data=JsonApiWorkspaceDataFilterSettingIn( - attributes=JsonApiWorkspaceDataFilterSettingInAttributes( - description="description_example", - filter_values=[ - "filter_values_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiWorkspaceDataFilterSettingInRelationships( - workspace_data_filter=JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter( - data=JsonApiWorkspaceDataFilterToOneLinkage(None), - ), - ), - type="workspaceDataFilterSetting", + entity_search_body = EntitySearchBody( + filter="filter_example", + include=[ + "include_example", + ], + meta_include=[ + "meta_include_example", + ], + page=EntitySearchPage( + index=0, + size=100, ), - ) # JsonApiWorkspaceDataFilterSettingInDocument | - filter = "title==someString;description==someString;workspaceDataFilter.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "workspaceDataFilter", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + sort=[ + EntitySearchSort( + direction="ASC", + _property="_property_example", + ), + ], + ) # EntitySearchBody | Search request body with filter, pagination, and sorting options + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False # example passing only required values which don't have defaults set try: - # Put a Settings for Workspace Data Filter - api_response = api_instance.update_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_in_document) + # Search request for MemoryItem + api_response = api_instance.search_entities_memory_items(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_workspace_data_filter_settings: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->search_entities_memory_items: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Put a Settings for Workspace Data Filter - api_response = api_instance.update_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_in_document, filter=filter, include=include) + # Search request for MemoryItem + api_response = api_instance.search_entities_memory_items(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_workspace_data_filter_settings: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->search_entities_memory_items: %s\n" % e) ``` @@ -13162,14 +1518,13 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_workspace_data_filter_setting_in_document** | [**JsonApiWorkspaceDataFilterSettingInDocument**](JsonApiWorkspaceDataFilterSettingInDocument.md)| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False ### Return type -[**JsonApiWorkspaceDataFilterSettingOutDocument**](JsonApiWorkspaceDataFilterSettingOutDocument.md) +[**JsonApiMemoryItemOutList**](JsonApiMemoryItemOutList.md) ### Authorization @@ -13177,7 +1532,7 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Content-Type**: application/json - **Accept**: application/json, application/vnd.gooddata.api+json @@ -13189,10 +1544,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **update_entity_workspace_data_filters** -> JsonApiWorkspaceDataFilterOutDocument update_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_in_document) +# **update_entity_knowledge_recommendations** +> JsonApiKnowledgeRecommendationOutDocument update_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_in_document) + -Put a Workspace Data Filter ### Example @@ -13201,8 +1556,8 @@ Put a Workspace Data Filter import time import gooddata_api_client from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument +from gooddata_api_client.model.json_api_knowledge_recommendation_out_document import JsonApiKnowledgeRecommendationOutDocument +from gooddata_api_client.model.json_api_knowledge_recommendation_in_document import JsonApiKnowledgeRecommendationInDocument 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. @@ -13217,48 +1572,60 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) workspace_id = "workspaceId_example" # str | object_id = "objectId_example" # str | - json_api_workspace_data_filter_in_document = JsonApiWorkspaceDataFilterInDocument( - data=JsonApiWorkspaceDataFilterIn( - attributes=JsonApiWorkspaceDataFilterInAttributes( - column_name="column_name_example", + json_api_knowledge_recommendation_in_document = JsonApiKnowledgeRecommendationInDocument( + data=JsonApiKnowledgeRecommendationIn( + attributes=JsonApiKnowledgeRecommendationInAttributes( + analytical_dashboard_title="Portfolio Health Insights", + analyzed_period="2023-07", + analyzed_value=None, + are_relations_valid=True, + comparison_type="MONTH", + confidence=None, description="description_example", + direction="DECREASED", + metric_title="Revenue", + recommendations={}, + reference_period="2023-06", + reference_value=None, + source_count=2, + tags=[ + "tags_example", + ], title="title_example", + widget_id="widget-123", + widget_name="Revenue Trend", ), id="id1", - relationships=JsonApiWorkspaceDataFilterInRelationships( - filter_settings=JsonApiWorkspaceDataFilterInRelationshipsFilterSettings( - data=JsonApiWorkspaceDataFilterSettingToManyLinkage([ - JsonApiWorkspaceDataFilterSettingLinkage( - id="id_example", - type="workspaceDataFilterSetting", - ), - ]), + relationships=JsonApiKnowledgeRecommendationInRelationships( + analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + metric=JsonApiKnowledgeRecommendationInRelationshipsMetric( + data=JsonApiMetricToOneLinkage(None), ), ), - type="workspaceDataFilter", + type="knowledgeRecommendation", ), - ) # JsonApiWorkspaceDataFilterInDocument | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + ) # JsonApiKnowledgeRecommendationInDocument | + filter = "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "filterSettings", + "metric,analyticalDashboard", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) # example passing only required values which don't have defaults set try: - # Put a Workspace Data Filter - api_response = api_instance.update_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_in_document) + api_response = api_instance.update_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_in_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_workspace_data_filters: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->update_entity_knowledge_recommendations: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Put a Workspace Data Filter - api_response = api_instance.update_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_in_document, filter=filter, include=include) + api_response = api_instance.update_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_in_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_workspace_data_filters: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->update_entity_knowledge_recommendations: %s\n" % e) ``` @@ -13268,13 +1635,13 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | **object_id** | **str**| | - **json_api_workspace_data_filter_in_document** | [**JsonApiWorkspaceDataFilterInDocument**](JsonApiWorkspaceDataFilterInDocument.md)| | + **json_api_knowledge_recommendation_in_document** | [**JsonApiKnowledgeRecommendationInDocument**](JsonApiKnowledgeRecommendationInDocument.md)| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type -[**JsonApiWorkspaceDataFilterOutDocument**](JsonApiWorkspaceDataFilterOutDocument.md) +[**JsonApiKnowledgeRecommendationOutDocument**](JsonApiKnowledgeRecommendationOutDocument.md) ### Authorization @@ -13294,10 +1661,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **update_entity_workspace_settings** -> JsonApiWorkspaceSettingOutDocument update_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_in_document) +# **update_entity_memory_items** +> JsonApiMemoryItemOutDocument update_entity_memory_items(workspace_id, object_id, json_api_memory_item_in_document) + -Put a Setting for a Workspace ### Example @@ -13306,8 +1673,8 @@ Put a Setting for a Workspace import time import gooddata_api_client from gooddata_api_client.api import workspace_object_controller_api -from gooddata_api_client.model.json_api_workspace_setting_in_document import JsonApiWorkspaceSettingInDocument -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.model.json_api_memory_item_in_document import JsonApiMemoryItemInDocument +from gooddata_api_client.model.json_api_memory_item_out_document import JsonApiMemoryItemOutDocument 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. @@ -13322,34 +1689,45 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = workspace_object_controller_api.WorkspaceObjectControllerApi(api_client) workspace_id = "workspaceId_example" # str | object_id = "objectId_example" # str | - json_api_workspace_setting_in_document = JsonApiWorkspaceSettingInDocument( - data=JsonApiWorkspaceSettingIn( - attributes=JsonApiOrganizationSettingInAttributes( - content={}, - type="TIMEZONE", + json_api_memory_item_in_document = JsonApiMemoryItemInDocument( + data=JsonApiMemoryItemIn( + attributes=JsonApiMemoryItemInAttributes( + are_relations_valid=True, + description="description_example", + instruction="instruction_example", + is_disabled=True, + keywords=[ + "keywords_example", + ], + strategy="ALWAYS", + tags=[ + "tags_example", + ], + title="title_example", ), id="id1", - type="workspaceSetting", + type="memoryItem", ), - ) # JsonApiWorkspaceSettingInDocument | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + ) # JsonApiMemoryItemInDocument | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) # example passing only required values which don't have defaults set try: - # Put a Setting for a Workspace - api_response = api_instance.update_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_in_document) + api_response = api_instance.update_entity_memory_items(workspace_id, object_id, json_api_memory_item_in_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_workspace_settings: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->update_entity_memory_items: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Put a Setting for a Workspace - api_response = api_instance.update_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_in_document, filter=filter) + api_response = api_instance.update_entity_memory_items(workspace_id, object_id, json_api_memory_item_in_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling WorkspaceObjectControllerApi->update_entity_workspace_settings: %s\n" % e) + print("Exception when calling WorkspaceObjectControllerApi->update_entity_memory_items: %s\n" % e) ``` @@ -13359,12 +1737,13 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | **object_id** | **str**| | - **json_api_workspace_setting_in_document** | [**JsonApiWorkspaceSettingInDocument**](JsonApiWorkspaceSettingInDocument.md)| | + **json_api_memory_item_in_document** | [**JsonApiMemoryItemInDocument**](JsonApiMemoryItemInDocument.md)| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type -[**JsonApiWorkspaceSettingOutDocument**](JsonApiWorkspaceSettingOutDocument.md) +[**JsonApiMemoryItemOutDocument**](JsonApiMemoryItemOutDocument.md) ### Authorization diff --git a/gooddata-api-client/docs/WorkspaceSettingControllerApi.md b/gooddata-api-client/docs/WorkspaceSettingControllerApi.md new file mode 100644 index 000000000..634267afa --- /dev/null +++ b/gooddata-api-client/docs/WorkspaceSettingControllerApi.md @@ -0,0 +1,635 @@ +# gooddata_api_client.WorkspaceSettingControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_workspace_settings**](WorkspaceSettingControllerApi.md#create_entity_workspace_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings | Post Settings for Workspaces +[**delete_entity_workspace_settings**](WorkspaceSettingControllerApi.md#delete_entity_workspace_settings) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Delete a Setting for Workspace +[**get_all_entities_workspace_settings**](WorkspaceSettingControllerApi.md#get_all_entities_workspace_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings | Get all Setting for Workspaces +[**get_entity_workspace_settings**](WorkspaceSettingControllerApi.md#get_entity_workspace_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Get a Setting for Workspace +[**patch_entity_workspace_settings**](WorkspaceSettingControllerApi.md#patch_entity_workspace_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Patch a Setting for Workspace +[**search_entities_workspace_settings**](WorkspaceSettingControllerApi.md#search_entities_workspace_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/search | The search endpoint (beta) +[**update_entity_workspace_settings**](WorkspaceSettingControllerApi.md#update_entity_workspace_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Put a Setting for a Workspace + + +# **create_entity_workspace_settings** +> JsonApiWorkspaceSettingOutDocument create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document) + +Post Settings for Workspaces + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_setting_controller_api +from gooddata_api_client.model.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument +from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = workspace_setting_controller_api.WorkspaceSettingControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + json_api_workspace_setting_post_optional_id_document = JsonApiWorkspaceSettingPostOptionalIdDocument( + data=JsonApiWorkspaceSettingPostOptionalId( + attributes=JsonApiOrganizationSettingInAttributes( + content={}, + type="TIMEZONE", + ), + id="id1", + type="workspaceSetting", + ), + ) # JsonApiWorkspaceSettingPostOptionalIdDocument | + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Settings for Workspaces + api_response = api_instance.create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceSettingControllerApi->create_entity_workspace_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Settings for Workspaces + api_response = api_instance.create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceSettingControllerApi->create_entity_workspace_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_workspace_setting_post_optional_id_document** | [**JsonApiWorkspaceSettingPostOptionalIdDocument**](JsonApiWorkspaceSettingPostOptionalIdDocument.md)| | + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceSettingOutDocument**](JsonApiWorkspaceSettingOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_entity_workspace_settings** +> delete_entity_workspace_settings(workspace_id, object_id) + +Delete a Setting for Workspace + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_setting_controller_api +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = workspace_setting_controller_api.WorkspaceSettingControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Delete a Setting for Workspace + api_instance.delete_entity_workspace_settings(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceSettingControllerApi->delete_entity_workspace_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete a Setting for Workspace + api_instance.delete_entity_workspace_settings(workspace_id, object_id, filter=filter) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceSettingControllerApi->delete_entity_workspace_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successfully deleted | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_entities_workspace_settings** +> JsonApiWorkspaceSettingOutList get_all_entities_workspace_settings(workspace_id) + +Get all Setting for Workspaces + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_setting_controller_api +from gooddata_api_client.model.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = workspace_setting_controller_api.WorkspaceSettingControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get all Setting for Workspaces + api_response = api_instance.get_all_entities_workspace_settings(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceSettingControllerApi->get_all_entities_workspace_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Setting for Workspaces + api_response = api_instance.get_all_entities_workspace_settings(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceSettingControllerApi->get_all_entities_workspace_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceSettingOutList**](JsonApiWorkspaceSettingOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_workspace_settings** +> JsonApiWorkspaceSettingOutDocument get_entity_workspace_settings(workspace_id, object_id) + +Get a Setting for Workspace + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_setting_controller_api +from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = workspace_setting_controller_api.WorkspaceSettingControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a Setting for Workspace + api_response = api_instance.get_entity_workspace_settings(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceSettingControllerApi->get_entity_workspace_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Setting for Workspace + api_response = api_instance.get_entity_workspace_settings(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceSettingControllerApi->get_entity_workspace_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceSettingOutDocument**](JsonApiWorkspaceSettingOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **patch_entity_workspace_settings** +> JsonApiWorkspaceSettingOutDocument patch_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_patch_document) + +Patch a Setting for Workspace + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_setting_controller_api +from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.model.json_api_workspace_setting_patch_document import JsonApiWorkspaceSettingPatchDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = workspace_setting_controller_api.WorkspaceSettingControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_workspace_setting_patch_document = JsonApiWorkspaceSettingPatchDocument( + data=JsonApiWorkspaceSettingPatch( + attributes=JsonApiOrganizationSettingInAttributes( + content={}, + type="TIMEZONE", + ), + id="id1", + type="workspaceSetting", + ), + ) # JsonApiWorkspaceSettingPatchDocument | + filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Patch a Setting for Workspace + api_response = api_instance.patch_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceSettingControllerApi->patch_entity_workspace_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch a Setting for Workspace + api_response = api_instance.patch_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_patch_document, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceSettingControllerApi->patch_entity_workspace_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_setting_patch_document** | [**JsonApiWorkspaceSettingPatchDocument**](JsonApiWorkspaceSettingPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiWorkspaceSettingOutDocument**](JsonApiWorkspaceSettingOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **search_entities_workspace_settings** +> JsonApiWorkspaceSettingOutList search_entities_workspace_settings(workspace_id, entity_search_body) + +The search endpoint (beta) + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_setting_controller_api +from gooddata_api_client.model.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = workspace_setting_controller_api.WorkspaceSettingControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + entity_search_body = EntitySearchBody( + filter="filter_example", + include=[ + "include_example", + ], + meta_include=[ + "meta_include_example", + ], + page=EntitySearchPage( + index=0, + size=100, + ), + sort=[ + EntitySearchSort( + direction="ASC", + _property="_property_example", + ), + ], + ) # EntitySearchBody | Search request body with filter, pagination, and sorting options + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_workspace_settings(workspace_id, entity_search_body) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceSettingControllerApi->search_entities_workspace_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_workspace_settings(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceSettingControllerApi->search_entities_workspace_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + +### Return type + +[**JsonApiWorkspaceSettingOutList**](JsonApiWorkspaceSettingOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_entity_workspace_settings** +> JsonApiWorkspaceSettingOutDocument update_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_in_document) + +Put a Setting for a Workspace + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_setting_controller_api +from gooddata_api_client.model.json_api_workspace_setting_in_document import JsonApiWorkspaceSettingInDocument +from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +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 = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = workspace_setting_controller_api.WorkspaceSettingControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_workspace_setting_in_document = JsonApiWorkspaceSettingInDocument( + data=JsonApiWorkspaceSettingIn( + attributes=JsonApiOrganizationSettingInAttributes( + content={}, + type="TIMEZONE", + ), + id="id1", + type="workspaceSetting", + ), + ) # JsonApiWorkspaceSettingInDocument | + filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Put a Setting for a Workspace + api_response = api_instance.update_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceSettingControllerApi->update_entity_workspace_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put a Setting for a Workspace + api_response = api_instance.update_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_in_document, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceSettingControllerApi->update_entity_workspace_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_setting_in_document** | [**JsonApiWorkspaceSettingInDocument**](JsonApiWorkspaceSettingInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiWorkspaceSettingOutDocument**](JsonApiWorkspaceSettingOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md b/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md index a700e3ff5..5e88b103f 100644 --- a/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md @@ -878,6 +878,7 @@ with gooddata_api_client.ApiClient() as api_client: settings=Settings( delimiter="U", export_info=True, + grand_totals_position="pinnedBottom", merge_headers=True, page_orientation="PORTRAIT", page_size="A4", diff --git a/gooddata-api-client/docs/WorkspacesSettingsApi.md b/gooddata-api-client/docs/WorkspacesSettingsApi.md index bd20c3049..cfc51d37f 100644 --- a/gooddata-api-client/docs/WorkspacesSettingsApi.md +++ b/gooddata-api-client/docs/WorkspacesSettingsApi.md @@ -14,8 +14,8 @@ Method | HTTP request | Description [**get_entity_workspace_settings**](WorkspacesSettingsApi.md#get_entity_workspace_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Get a Setting for Workspace [**patch_entity_custom_application_settings**](WorkspacesSettingsApi.md#patch_entity_custom_application_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Patch a Custom Application Setting [**patch_entity_workspace_settings**](WorkspacesSettingsApi.md#patch_entity_workspace_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Patch a Setting for Workspace -[**search_entities_custom_application_settings**](WorkspacesSettingsApi.md#search_entities_custom_application_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search | Search request for CustomApplicationSetting -[**search_entities_workspace_settings**](WorkspacesSettingsApi.md#search_entities_workspace_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/search | +[**search_entities_custom_application_settings**](WorkspacesSettingsApi.md#search_entities_custom_application_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search | The search endpoint (beta) +[**search_entities_workspace_settings**](WorkspacesSettingsApi.md#search_entities_workspace_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/search | The search endpoint (beta) [**update_entity_custom_application_settings**](WorkspacesSettingsApi.md#update_entity_custom_application_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Put a Custom Application Setting [**update_entity_workspace_settings**](WorkspacesSettingsApi.md#update_entity_workspace_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Put a Setting for a Workspace [**workspace_resolve_all_settings**](WorkspacesSettingsApi.md#workspace_resolve_all_settings) | **GET** /api/v1/actions/workspaces/{workspaceId}/resolveSettings | Values for all settings. @@ -887,7 +887,7 @@ No authorization required # **search_entities_custom_application_settings** > JsonApiCustomApplicationSettingOutList search_entities_custom_application_settings(workspace_id, entity_search_body) -Search request for CustomApplicationSetting +The search endpoint (beta) ### Example @@ -935,7 +935,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Search request for CustomApplicationSetting + # The search endpoint (beta) api_response = api_instance.search_entities_custom_application_settings(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -944,7 +944,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Search request for CustomApplicationSetting + # The search endpoint (beta) api_response = api_instance.search_entities_custom_application_settings(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -986,7 +986,7 @@ No authorization required # **search_entities_workspace_settings** > JsonApiWorkspaceSettingOutList search_entities_workspace_settings(workspace_id, entity_search_body) - +The search endpoint (beta) ### Example @@ -1034,6 +1034,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: + # The search endpoint (beta) api_response = api_instance.search_entities_workspace_settings(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -1042,6 +1043,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: + # The search endpoint (beta) api_response = api_instance.search_entities_workspace_settings(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/gooddata_api_client/api/actions_api.py b/gooddata-api-client/gooddata_api_client/api/actions_api.py index a578be876..489797c50 100644 --- a/gooddata-api-client/gooddata_api_client/api/actions_api.py +++ b/gooddata-api-client/gooddata_api_client/api/actions_api.py @@ -80,6 +80,8 @@ from gooddata_api_client.model.key_drivers_result import KeyDriversResult from gooddata_api_client.model.knowledge_document_metadata_dto import KnowledgeDocumentMetadataDto from gooddata_api_client.model.list_knowledge_documents_response_dto import ListKnowledgeDocumentsResponseDto +from gooddata_api_client.model.list_llm_provider_models_request import ListLlmProviderModelsRequest +from gooddata_api_client.model.list_llm_provider_models_response import ListLlmProviderModelsResponse from gooddata_api_client.model.locale_request import LocaleRequest from gooddata_api_client.model.manage_dashboard_permissions_request_inner import ManageDashboardPermissionsRequestInner from gooddata_api_client.model.memory_item_created_by_users import MemoryItemCreatedByUsers @@ -112,10 +114,12 @@ from gooddata_api_client.model.tabular_export_request import TabularExportRequest from gooddata_api_client.model.test_definition_request import TestDefinitionRequest from gooddata_api_client.model.test_destination_request import TestDestinationRequest +from gooddata_api_client.model.test_llm_provider_by_id_request import TestLlmProviderByIdRequest from gooddata_api_client.model.test_llm_provider_definition_request import TestLlmProviderDefinitionRequest from gooddata_api_client.model.test_llm_provider_response import TestLlmProviderResponse from gooddata_api_client.model.test_request import TestRequest from gooddata_api_client.model.test_response import TestResponse +from gooddata_api_client.model.trending_objects_result import TrendingObjectsResult from gooddata_api_client.model.trigger_automation_request import TriggerAutomationRequest from gooddata_api_client.model.trigger_quality_issues_calculation_response import TriggerQualityIssuesCalculationResponse from gooddata_api_client.model.upsert_knowledge_document_request_dto import UpsertKnowledgeDocumentRequestDto @@ -3821,6 +3825,8 @@ def __init__(self, api_client=None): 'size', 'page_token', 'meta_include', + 'state', + 'query', ], 'required': [ 'workspace_id', @@ -3855,6 +3861,10 @@ def __init__(self, api_client=None): (str,), 'meta_include': (str,), + 'state': + (str,), + 'query': + (str,), }, 'attribute_map': { 'workspace_id': 'workspaceId', @@ -3862,6 +3872,8 @@ def __init__(self, api_client=None): 'size': 'size', 'page_token': 'pageToken', 'meta_include': 'metaInclude', + 'state': 'state', + 'query': 'query', }, 'location_map': { 'workspace_id': 'path', @@ -3869,6 +3881,8 @@ def __init__(self, api_client=None): 'size': 'query', 'page_token': 'query', 'meta_include': 'query', + 'state': 'query', + 'query': 'query', }, 'collection_format_map': { 'scopes': 'multi', @@ -3882,6 +3896,105 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.list_llm_provider_models_endpoint = _Endpoint( + settings={ + 'response_type': (ListLlmProviderModelsResponse,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/ai/llmProvider/listModels', + 'operation_id': 'list_llm_provider_models', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'list_llm_provider_models_request', + ], + 'required': [ + 'list_llm_provider_models_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'list_llm_provider_models_request': + (ListLlmProviderModelsRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'list_llm_provider_models_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.list_llm_provider_models_by_id_endpoint = _Endpoint( + settings={ + 'response_type': (ListLlmProviderModelsResponse,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/ai/llmProvider/{llmProviderId}/listModels', + 'operation_id': 'list_llm_provider_models_by_id', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'llm_provider_id', + ], + 'required': [ + 'llm_provider_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'llm_provider_id': + (str,), + }, + 'attribute_map': { + 'llm_provider_id': 'llmProviderId', + }, + 'location_map': { + 'llm_provider_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.list_workspace_user_groups_endpoint = _Endpoint( settings={ 'response_type': (WorkspaceUserGroups,), @@ -5283,10 +5396,10 @@ def __init__(self, api_client=None): 'all': [ 'workspace_id', 'result_id', + 'x_gdc_cancel_token', 'offset', 'limit', 'excluded_total_dimensions', - 'x_gdc_cancel_token', ], 'required': [ 'workspace_id', @@ -5316,30 +5429,30 @@ def __init__(self, api_client=None): (str,), 'result_id': (str,), + 'x_gdc_cancel_token': + (str,), 'offset': ([int],), 'limit': ([int],), 'excluded_total_dimensions': ([str],), - 'x_gdc_cancel_token': - (str,), }, 'attribute_map': { 'workspace_id': 'workspaceId', 'result_id': 'resultId', + 'x_gdc_cancel_token': 'X-GDC-CANCEL-TOKEN', 'offset': 'offset', 'limit': 'limit', 'excluded_total_dimensions': 'excludedTotalDimensions', - 'x_gdc_cancel_token': 'X-GDC-CANCEL-TOKEN', }, 'location_map': { 'workspace_id': 'path', 'result_id': 'path', + 'x_gdc_cancel_token': 'header', 'offset': 'query', 'limit': 'query', 'excluded_total_dimensions': 'query', - 'x_gdc_cancel_token': 'header', }, 'collection_format_map': { 'offset': 'csv', @@ -5349,7 +5462,9 @@ def __init__(self, api_client=None): }, headers_map={ 'accept': [ - 'application/json' + 'application/json', + 'application/vnd.apache.arrow.file', + 'application/vnd.apache.arrow.stream' ], 'content_type': [], }, @@ -6057,6 +6172,7 @@ def __init__(self, api_client=None): params_map={ 'all': [ 'llm_provider_id', + 'test_llm_provider_by_id_request', ], 'required': [ 'llm_provider_id', @@ -6076,12 +6192,15 @@ def __init__(self, api_client=None): 'openapi_types': { 'llm_provider_id': (str,), + 'test_llm_provider_by_id_request': + (TestLlmProviderByIdRequest,), }, 'attribute_map': { 'llm_provider_id': 'llmProviderId', }, 'location_map': { 'llm_provider_id': 'path', + 'test_llm_provider_by_id_request': 'body', }, 'collection_format_map': { } @@ -6090,7 +6209,9 @@ def __init__(self, api_client=None): 'accept': [ 'application/json' ], - 'content_type': [], + 'content_type': [ + 'application/json' + ] }, api_client=api_client ) @@ -6144,6 +6265,62 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.trending_objects_endpoint = _Endpoint( + settings={ + 'response_type': (TrendingObjectsResult,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/trendingObjects', + 'operation_id': 'trending_objects', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'workspace_id', + ] + }, + root_map={ + 'validations': { + ('workspace_id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + }, + 'location_map': { + 'workspace_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.trigger_automation_endpoint = _Endpoint( settings={ 'response_type': None, @@ -12156,6 +12333,8 @@ def list_documents( size (int): [optional] if omitted the server will use the default value of 50 page_token (str): [optional] meta_include (str): [optional] + state (str): [optional] + query (str): [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -12221,6 +12400,172 @@ def list_documents( workspace_id return self.list_documents_endpoint.call_with_http_info(**kwargs) + def list_llm_provider_models( + self, + list_llm_provider_models_request, + **kwargs + ): + """List LLM Provider Models # noqa: E501 + + Lists models available on an LLM provider with a full definition. For Azure AI Foundry providers, the model family will be set to UNKNOWN because the endpoint does not expose the family. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_llm_provider_models(list_llm_provider_models_request, async_req=True) + >>> result = thread.get() + + Args: + list_llm_provider_models_request (ListLlmProviderModelsRequest): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + ListLlmProviderModelsResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['list_llm_provider_models_request'] = \ + list_llm_provider_models_request + return self.list_llm_provider_models_endpoint.call_with_http_info(**kwargs) + + def list_llm_provider_models_by_id( + self, + llm_provider_id, + **kwargs + ): + """List LLM Provider Models By Id # noqa: E501 + + Lists models available on an existing LLM provider by its ID. For Azure AI Foundry providers, the model family will be set to UNKNOWN because the endpoint does not expose the family. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_llm_provider_models_by_id(llm_provider_id, async_req=True) + >>> result = thread.get() + + Args: + llm_provider_id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + ListLlmProviderModelsResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['llm_provider_id'] = \ + llm_provider_id + return self.list_llm_provider_models_by_id_endpoint.call_with_http_info(**kwargs) + def list_workspace_user_groups( self, workspace_id, @@ -14408,7 +14753,7 @@ def retrieve_result( ): """Get a single execution result # noqa: E501 - Gets a single execution result. # noqa: E501 + Gets a single execution result. Note that the Arrow File and Arrow Stream content types are currently in BETA. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -14420,10 +14765,10 @@ def retrieve_result( result_id (str): Result ID Keyword Args: + x_gdc_cancel_token (str): [optional] offset ([int]): Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM.. [optional] if omitted the server will use the default value of [] limit ([int]): Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM.. [optional] if omitted the server will use the default value of [] excluded_total_dimensions ([str]): Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions.. [optional] if omitted the server will use the default value of [] - x_gdc_cancel_token (str): [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -15536,6 +15881,7 @@ def test_llm_provider_by_id( llm_provider_id (str): Keyword Args: + test_llm_provider_by_id_request (TestLlmProviderByIdRequest): [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -15684,6 +16030,89 @@ def test_notification_channel( test_destination_request return self.test_notification_channel_endpoint.call_with_http_info(**kwargs) + def trending_objects( + self, + workspace_id, + **kwargs + ): + """Get Trending Analytics Catalog Objects # noqa: E501 + + Returns a list of trending objects for this workspace # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.trending_objects(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): Workspace identifier + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + TrendingObjectsResult + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.trending_objects_endpoint.call_with_http_info(**kwargs) + def trigger_automation( self, workspace_id, diff --git a/gooddata-api-client/gooddata_api_client/api/ai_api.py b/gooddata-api-client/gooddata_api_client/api/ai_api.py index 14aec7cb8..cf95a7531 100644 --- a/gooddata-api-client/gooddata_api_client/api/ai_api.py +++ b/gooddata-api-client/gooddata_api_client/api/ai_api.py @@ -2526,7 +2526,7 @@ def search_entities_knowledge_recommendations( entity_search_body, **kwargs ): - """search_entities_knowledge_recommendations # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/ai_lake_api.py b/gooddata-api-client/gooddata_api_client/api/ai_lake_api.py index ec99b3761..43364536d 100644 --- a/gooddata-api-client/gooddata_api_client/api/ai_lake_api.py +++ b/gooddata-api-client/gooddata_api_client/api/ai_lake_api.py @@ -24,6 +24,7 @@ ) from gooddata_api_client.model.database_instance import DatabaseInstance from gooddata_api_client.model.get_ai_lake_operation200_response import GetAiLakeOperation200Response +from gooddata_api_client.model.get_service_status_response import GetServiceStatusResponse from gooddata_api_client.model.list_database_instances_response import ListDatabaseInstancesResponse from gooddata_api_client.model.list_services_response import ListServicesResponse from gooddata_api_client.model.provision_database_instance_request import ProvisionDatabaseInstanceRequest @@ -193,6 +194,55 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.get_ai_lake_service_status_endpoint = _Endpoint( + settings={ + 'response_type': (GetServiceStatusResponse,), + 'auth': [], + 'endpoint_path': '/api/v1/ailake/services/{serviceId}/status', + 'operation_id': 'get_ai_lake_service_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + ], + 'required': [ + 'service_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + }, + 'location_map': { + 'service_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.list_ai_lake_database_instances_endpoint = _Endpoint( settings={ 'response_type': (ListDatabaseInstancesResponse,), @@ -690,6 +740,89 @@ def get_ai_lake_operation( operation_id return self.get_ai_lake_operation_endpoint.call_with_http_info(**kwargs) + def get_ai_lake_service_status( + self, + service_id, + **kwargs + ): + """(BETA) Get AI Lake service status # noqa: E501 + + (BETA) Returns the status of a service in the organization's AI Lake. The status is controller-specific (e.g., available commands, readiness). # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_ai_lake_service_status(service_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + GetServiceStatusResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + return self.get_ai_lake_service_status_endpoint.call_with_http_info(**kwargs) + def list_ai_lake_database_instances( self, **kwargs diff --git a/gooddata-api-client/gooddata_api_client/api/analytical_dashboard_controller_api.py b/gooddata-api-client/gooddata_api_client/api/analytical_dashboard_controller_api.py new file mode 100644 index 000000000..d8b434ff4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/analytical_dashboard_controller_api.py @@ -0,0 +1,1321 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint +from gooddata_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from gooddata_api_client.model.entity_search_body import EntitySearchBody +from gooddata_api_client.model.json_api_analytical_dashboard_in_document import JsonApiAnalyticalDashboardInDocument +from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.model.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList +from gooddata_api_client.model.json_api_analytical_dashboard_patch_document import JsonApiAnalyticalDashboardPatchDocument +from gooddata_api_client.model.json_api_analytical_dashboard_post_optional_id_document import JsonApiAnalyticalDashboardPostOptionalIdDocument + + +class AnalyticalDashboardControllerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_entity_analytical_dashboards_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiAnalyticalDashboardOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards', + 'operation_id': 'create_entity_analytical_dashboards', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_analytical_dashboard_post_optional_id_document', + 'include', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_analytical_dashboard_post_optional_id_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "VISUALIZATIONOBJECTS": "visualizationObjects", + "ANALYTICALDASHBOARDS": "analyticalDashboards", + "LABELS": "labels", + "METRICS": "metrics", + "DATASETS": "datasets", + "FILTERCONTEXTS": "filterContexts", + "DASHBOARDPLUGINS": "dashboardPlugins", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", + "ALL": "ALL" + }, + ('meta_include',): { + + "PERMISSIONS": "permissions", + "ORIGIN": "origin", + "ACCESSINFO": "accessInfo", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'json_api_analytical_dashboard_post_optional_id_document': + (JsonApiAnalyticalDashboardPostOptionalIdDocument,), + 'include': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'include': 'include', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_analytical_dashboard_post_optional_id_document': 'body', + 'include': 'query', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.delete_entity_analytical_dashboards_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}', + 'operation_id': 'delete_entity_analytical_dashboards', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_entities_analytical_dashboards_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiAnalyticalDashboardOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards', + 'operation_id': 'get_all_entities_analytical_dashboards', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'origin', + 'filter', + 'include', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "VISUALIZATIONOBJECTS": "visualizationObjects", + "ANALYTICALDASHBOARDS": "analyticalDashboards", + "LABELS": "labels", + "METRICS": "metrics", + "DATASETS": "datasets", + "FILTERCONTEXTS": "filterContexts", + "DASHBOARDPLUGINS": "dashboardPlugins", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", + "ALL": "ALL" + }, + ('meta_include',): { + + "PERMISSIONS": "permissions", + "ORIGIN": "origin", + "ACCESSINFO": "accessInfo", + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'origin': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'filter': 'filter', + 'include': 'include', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'origin': 'query', + 'filter': 'query', + 'include': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_analytical_dashboards_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiAnalyticalDashboardOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}', + 'operation_id': 'get_entity_analytical_dashboards', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + 'include', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "VISUALIZATIONOBJECTS": "visualizationObjects", + "ANALYTICALDASHBOARDS": "analyticalDashboards", + "LABELS": "labels", + "METRICS": "metrics", + "DATASETS": "datasets", + "FILTERCONTEXTS": "filterContexts", + "DASHBOARDPLUGINS": "dashboardPlugins", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", + "ALL": "ALL" + }, + ('meta_include',): { + + "PERMISSIONS": "permissions", + "ORIGIN": "origin", + "ACCESSINFO": "accessInfo", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + 'include': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.patch_entity_analytical_dashboards_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiAnalyticalDashboardOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}', + 'operation_id': 'patch_entity_analytical_dashboards', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_analytical_dashboard_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_analytical_dashboard_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "VISUALIZATIONOBJECTS": "visualizationObjects", + "ANALYTICALDASHBOARDS": "analyticalDashboards", + "LABELS": "labels", + "METRICS": "metrics", + "DATASETS": "datasets", + "FILTERCONTEXTS": "filterContexts", + "DASHBOARDPLUGINS": "dashboardPlugins", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_analytical_dashboard_patch_document': + (JsonApiAnalyticalDashboardPatchDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_analytical_dashboard_patch_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.search_entities_analytical_dashboards_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiAnalyticalDashboardOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search', + 'operation_id': 'search_entities_analytical_dashboards', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'entity_search_body', + 'origin', + 'x_gdc_validate_relations', + ], + 'required': [ + 'workspace_id', + 'entity_search_body', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'entity_search_body': + (EntitySearchBody,), + 'origin': + (str,), + 'x_gdc_validate_relations': + (bool,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + }, + 'location_map': { + 'workspace_id': 'path', + 'entity_search_body': 'body', + 'origin': 'query', + 'x_gdc_validate_relations': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_entity_analytical_dashboards_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiAnalyticalDashboardOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}', + 'operation_id': 'update_entity_analytical_dashboards', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_analytical_dashboard_in_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_analytical_dashboard_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "VISUALIZATIONOBJECTS": "visualizationObjects", + "ANALYTICALDASHBOARDS": "analyticalDashboards", + "LABELS": "labels", + "METRICS": "metrics", + "DATASETS": "datasets", + "FILTERCONTEXTS": "filterContexts", + "DASHBOARDPLUGINS": "dashboardPlugins", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_analytical_dashboard_in_document': + (JsonApiAnalyticalDashboardInDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_analytical_dashboard_in_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + + def create_entity_analytical_dashboards( + self, + workspace_id, + json_api_analytical_dashboard_post_optional_id_document, + **kwargs + ): + """Post Dashboards # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_analytical_dashboards(workspace_id, json_api_analytical_dashboard_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_analytical_dashboard_post_optional_id_document (JsonApiAnalyticalDashboardPostOptionalIdDocument): + + Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiAnalyticalDashboardOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['json_api_analytical_dashboard_post_optional_id_document'] = \ + json_api_analytical_dashboard_post_optional_id_document + return self.create_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) + + def delete_entity_analytical_dashboards( + self, + workspace_id, + object_id, + **kwargs + ): + """Delete a Dashboard # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_entity_analytical_dashboards(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_analytical_dashboards( + self, + workspace_id, + **kwargs + ): + """Get all Dashboards # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_analytical_dashboards(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiAnalyticalDashboardOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_analytical_dashboards_endpoint.call_with_http_info(**kwargs) + + def get_entity_analytical_dashboards( + self, + workspace_id, + object_id, + **kwargs + ): + """Get a Dashboard # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_analytical_dashboards(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiAnalyticalDashboardOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) + + def patch_entity_analytical_dashboards( + self, + workspace_id, + object_id, + json_api_analytical_dashboard_patch_document, + **kwargs + ): + """Patch a Dashboard # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_analytical_dashboard_patch_document (JsonApiAnalyticalDashboardPatchDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiAnalyticalDashboardOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_analytical_dashboard_patch_document'] = \ + json_api_analytical_dashboard_patch_document + return self.patch_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) + + def search_entities_analytical_dashboards( + self, + workspace_id, + entity_search_body, + **kwargs + ): + """The search endpoint (beta) # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_entities_analytical_dashboards(workspace_id, entity_search_body, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiAnalyticalDashboardOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['entity_search_body'] = \ + entity_search_body + return self.search_entities_analytical_dashboards_endpoint.call_with_http_info(**kwargs) + + def update_entity_analytical_dashboards( + self, + workspace_id, + object_id, + json_api_analytical_dashboard_in_document, + **kwargs + ): + """Put Dashboards # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_analytical_dashboard_in_document (JsonApiAnalyticalDashboardInDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiAnalyticalDashboardOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_analytical_dashboard_in_document'] = \ + json_api_analytical_dashboard_in_document + return self.update_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/api_token_controller_api.py b/gooddata-api-client/gooddata_api_client/api/api_token_controller_api.py new file mode 100644 index 000000000..db7a27f79 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/api_token_controller_api.py @@ -0,0 +1,667 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint +from gooddata_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +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 + + +class ApiTokenControllerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_entity_api_tokens_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiApiTokenOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/users/{userId}/apiTokens', + 'operation_id': 'create_entity_api_tokens', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'user_id', + 'json_api_api_token_in_document', + ], + 'required': [ + 'user_id', + 'json_api_api_token_in_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'user_id': + (str,), + 'json_api_api_token_in_document': + (JsonApiApiTokenInDocument,), + }, + 'attribute_map': { + 'user_id': 'userId', + }, + 'location_map': { + 'user_id': 'path', + 'json_api_api_token_in_document': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.delete_entity_api_tokens_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/users/{userId}/apiTokens/{id}', + 'operation_id': 'delete_entity_api_tokens', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'user_id', + 'id', + 'filter', + ], + 'required': [ + 'user_id', + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'user_id': + (str,), + 'id': + (str,), + 'filter': + (str,), + }, + 'attribute_map': { + 'user_id': 'userId', + 'id': 'id', + 'filter': 'filter', + }, + 'location_map': { + 'user_id': 'path', + 'id': 'path', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_entities_api_tokens_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiApiTokenOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/users/{userId}/apiTokens', + 'operation_id': 'get_all_entities_api_tokens', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'user_id', + 'filter', + 'page', + 'size', + 'sort', + 'meta_include', + ], + 'required': [ + 'user_id', + ], + 'nullable': [ + ], + 'enum': [ + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('meta_include',): { + + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'user_id': + (str,), + 'filter': + (str,), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'user_id': 'userId', + 'filter': 'filter', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'user_id': 'path', + 'filter': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_api_tokens_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiApiTokenOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/users/{userId}/apiTokens/{id}', + 'operation_id': 'get_entity_api_tokens', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'user_id', + 'id', + 'filter', + ], + 'required': [ + 'user_id', + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'user_id': + (str,), + 'id': + (str,), + 'filter': + (str,), + }, + 'attribute_map': { + 'user_id': 'userId', + 'id': 'id', + 'filter': 'filter', + }, + 'location_map': { + 'user_id': 'path', + 'id': 'path', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_entity_api_tokens( + self, + user_id, + json_api_api_token_in_document, + **kwargs + ): + """Post a new API token for the user # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_api_tokens(user_id, json_api_api_token_in_document, async_req=True) + >>> result = thread.get() + + Args: + user_id (str): + json_api_api_token_in_document (JsonApiApiTokenInDocument): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiApiTokenOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['user_id'] = \ + user_id + kwargs['json_api_api_token_in_document'] = \ + json_api_api_token_in_document + return self.create_entity_api_tokens_endpoint.call_with_http_info(**kwargs) + + def delete_entity_api_tokens( + self, + user_id, + id, + **kwargs + ): + """Delete an API Token for a user # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_entity_api_tokens(user_id, id, async_req=True) + >>> result = thread.get() + + Args: + user_id (str): + id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['user_id'] = \ + user_id + kwargs['id'] = \ + id + return self.delete_entity_api_tokens_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_api_tokens( + self, + user_id, + **kwargs + ): + """List all api tokens for a user # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_api_tokens(user_id, async_req=True) + >>> result = thread.get() + + Args: + user_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiApiTokenOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['user_id'] = \ + user_id + return self.get_all_entities_api_tokens_endpoint.call_with_http_info(**kwargs) + + def get_entity_api_tokens( + self, + user_id, + id, + **kwargs + ): + """Get an API Token for a user # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_api_tokens(user_id, id, async_req=True) + >>> result = thread.get() + + Args: + user_id (str): + id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiApiTokenOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['user_id'] = \ + user_id + kwargs['id'] = \ + id + return self.get_entity_api_tokens_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/attribute_controller_api.py b/gooddata-api-client/gooddata_api_client/api/attribute_controller_api.py new file mode 100644 index 000000000..65c6f8a76 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/attribute_controller_api.py @@ -0,0 +1,782 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint +from gooddata_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from gooddata_api_client.model.entity_search_body import EntitySearchBody +from gooddata_api_client.model.json_api_attribute_out_document import JsonApiAttributeOutDocument +from gooddata_api_client.model.json_api_attribute_out_list import JsonApiAttributeOutList +from gooddata_api_client.model.json_api_attribute_patch_document import JsonApiAttributePatchDocument + + +class AttributeControllerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_all_entities_attributes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiAttributeOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributes', + 'operation_id': 'get_all_entities_attributes', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'origin', + 'filter', + 'include', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('include',): { + + "DATASETS": "datasets", + "LABELS": "labels", + "ATTRIBUTEHIERARCHIES": "attributeHierarchies", + "DATASET": "dataset", + "DEFAULTVIEW": "defaultView", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'origin': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'filter': 'filter', + 'include': 'include', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'origin': 'query', + 'filter': 'query', + 'include': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_attributes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiAttributeOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributes/{objectId}', + 'operation_id': 'get_entity_attributes', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + 'include', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "DATASETS": "datasets", + "LABELS": "labels", + "ATTRIBUTEHIERARCHIES": "attributeHierarchies", + "DATASET": "dataset", + "DEFAULTVIEW": "defaultView", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + 'include': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.patch_entity_attributes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiAttributeOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributes/{objectId}', + 'operation_id': 'patch_entity_attributes', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_attribute_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_attribute_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "DATASETS": "datasets", + "LABELS": "labels", + "ATTRIBUTEHIERARCHIES": "attributeHierarchies", + "DATASET": "dataset", + "DEFAULTVIEW": "defaultView", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_attribute_patch_document': + (JsonApiAttributePatchDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_attribute_patch_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.search_entities_attributes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiAttributeOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributes/search', + 'operation_id': 'search_entities_attributes', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'entity_search_body', + 'origin', + 'x_gdc_validate_relations', + ], + 'required': [ + 'workspace_id', + 'entity_search_body', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'entity_search_body': + (EntitySearchBody,), + 'origin': + (str,), + 'x_gdc_validate_relations': + (bool,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + }, + 'location_map': { + 'workspace_id': 'path', + 'entity_search_body': 'body', + 'origin': 'query', + 'x_gdc_validate_relations': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def get_all_entities_attributes( + self, + workspace_id, + **kwargs + ): + """Get all Attributes # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_attributes(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiAttributeOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_attributes_endpoint.call_with_http_info(**kwargs) + + def get_entity_attributes( + self, + workspace_id, + object_id, + **kwargs + ): + """Get an Attribute # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_attributes(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiAttributeOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_attributes_endpoint.call_with_http_info(**kwargs) + + def patch_entity_attributes( + self, + workspace_id, + object_id, + json_api_attribute_patch_document, + **kwargs + ): + """Patch an Attribute (beta) # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_entity_attributes(workspace_id, object_id, json_api_attribute_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_attribute_patch_document (JsonApiAttributePatchDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiAttributeOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_attribute_patch_document'] = \ + json_api_attribute_patch_document + return self.patch_entity_attributes_endpoint.call_with_http_info(**kwargs) + + def search_entities_attributes( + self, + workspace_id, + entity_search_body, + **kwargs + ): + """The search endpoint (beta) # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_entities_attributes(workspace_id, entity_search_body, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiAttributeOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['entity_search_body'] = \ + entity_search_body + return self.search_entities_attributes_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/attribute_hierarchies_api.py b/gooddata-api-client/gooddata_api_client/api/attribute_hierarchies_api.py index 3a0738e07..8e291d7cd 100644 --- a/gooddata-api-client/gooddata_api_client/api/attribute_hierarchies_api.py +++ b/gooddata-api-client/gooddata_api_client/api/attribute_hierarchies_api.py @@ -1103,7 +1103,7 @@ def search_entities_attribute_hierarchies( entity_search_body, **kwargs ): - """Search request for AttributeHierarchy # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/user_model_controller_api.py b/gooddata-api-client/gooddata_api_client/api/attribute_hierarchy_controller_api.py similarity index 62% rename from gooddata-api-client/gooddata_api_client/api/user_model_controller_api.py rename to gooddata-api-client/gooddata_api_client/api/attribute_hierarchy_controller_api.py index af7eacb26..9be5c8c0e 100644 --- a/gooddata-api-client/gooddata_api_client/api/user_model_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/attribute_hierarchy_controller_api.py @@ -22,15 +22,14 @@ none_type, validate_and_convert_types ) -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 -from gooddata_api_client.model.json_api_user_setting_in_document import JsonApiUserSettingInDocument -from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument -from gooddata_api_client.model.json_api_user_setting_out_list import JsonApiUserSettingOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody +from gooddata_api_client.model.json_api_attribute_hierarchy_in_document import JsonApiAttributeHierarchyInDocument +from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +from gooddata_api_client.model.json_api_attribute_hierarchy_out_list import JsonApiAttributeHierarchyOutList +from gooddata_api_client.model.json_api_attribute_hierarchy_patch_document import JsonApiAttributeHierarchyPatchDocument -class UserModelControllerApi(object): +class AttributeHierarchyControllerApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech @@ -41,108 +40,82 @@ def __init__(self, api_client=None): if api_client is None: api_client = ApiClient() self.api_client = api_client - self.create_entity_api_tokens_endpoint = _Endpoint( + self.create_entity_attribute_hierarchies_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiApiTokenOutDocument,), + 'response_type': (JsonApiAttributeHierarchyOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/apiTokens', - 'operation_id': 'create_entity_api_tokens', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies', + 'operation_id': 'create_entity_attribute_hierarchies', 'http_method': 'POST', 'servers': None, }, params_map={ 'all': [ - 'user_id', - 'json_api_api_token_in_document', - ], - 'required': [ - 'user_id', - 'json_api_api_token_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_id': - (str,), - 'json_api_api_token_in_document': - (JsonApiApiTokenInDocument,), - }, - 'attribute_map': { - 'user_id': 'userId', - }, - 'location_map': { - 'user_id': 'path', - 'json_api_api_token_in_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_user_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings', - 'operation_id': 'create_entity_user_settings', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - 'json_api_user_setting_in_document', + 'workspace_id', + 'json_api_attribute_hierarchy_in_document', + 'include', + 'meta_include', ], 'required': [ - 'user_id', - 'json_api_user_setting_in_document', + 'workspace_id', + 'json_api_attribute_hierarchy_in_document', ], 'nullable': [ ], 'enum': [ + 'include', + 'meta_include', ], 'validation': [ + 'meta_include', ] }, root_map={ 'validations': { + ('meta_include',): { + + }, }, 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "ATTRIBUTES": "attributes", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, }, 'openapi_types': { - 'user_id': + 'workspace_id': (str,), - 'json_api_user_setting_in_document': - (JsonApiUserSettingInDocument,), + 'json_api_attribute_hierarchy_in_document': + (JsonApiAttributeHierarchyInDocument,), + 'include': + ([str],), + 'meta_include': + ([str],), }, 'attribute_map': { - 'user_id': 'userId', + 'workspace_id': 'workspaceId', + 'include': 'include', + 'meta_include': 'metaInclude', }, 'location_map': { - 'user_id': 'path', - 'json_api_user_setting_in_document': 'body', + 'workspace_id': 'path', + 'json_api_attribute_hierarchy_in_document': 'body', + 'include': 'query', + 'meta_include': 'query', }, 'collection_format_map': { + 'include': 'csv', + 'meta_include': 'csv', } }, headers_map={ @@ -157,60 +130,53 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_api_tokens_endpoint = _Endpoint( + self.delete_entity_attribute_hierarchies_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/apiTokens/{id}', - 'operation_id': 'delete_entity_api_tokens', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}', + 'operation_id': 'delete_entity_attribute_hierarchies', 'http_method': 'DELETE', 'servers': None, }, params_map={ 'all': [ - 'user_id', - 'id', + 'workspace_id', + 'object_id', 'filter', ], 'required': [ - 'user_id', - 'id', + 'workspace_id', + 'object_id', ], 'nullable': [ ], 'enum': [ ], 'validation': [ - 'id', ] }, root_map={ 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, }, 'allowed_values': { }, 'openapi_types': { - 'user_id': + 'workspace_id': (str,), - 'id': + 'object_id': (str,), 'filter': (str,), }, 'attribute_map': { - 'user_id': 'userId', - 'id': 'id', + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', 'filter': 'filter', }, 'location_map': { - 'user_id': 'path', - 'id': 'path', + 'workspace_id': 'path', + 'object_id': 'path', 'filter': 'query', }, 'collection_format_map': { @@ -222,95 +188,35 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_user_settings_endpoint = _Endpoint( + self.get_all_entities_attribute_hierarchies_endpoint = _Endpoint( settings={ - 'response_type': None, + 'response_type': (JsonApiAttributeHierarchyOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings/{id}', - 'operation_id': 'delete_entity_user_settings', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - 'id', - 'filter', - ], - 'required': [ - 'user_id', - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_id': - (str,), - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'user_id': 'userId', - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'user_id': 'path', - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_api_tokens_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiApiTokenOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/apiTokens', - 'operation_id': 'get_all_entities_api_tokens', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies', + 'operation_id': 'get_all_entities_attribute_hierarchies', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ - 'user_id', + 'workspace_id', + 'origin', 'filter', + 'include', 'page', 'size', 'sort', + 'x_gdc_validate_relations', 'meta_include', ], 'required': [ - 'user_id', + 'workspace_id', ], 'nullable': [ ], 'enum': [ + 'origin', + 'include', 'meta_include', ], 'validation': [ @@ -324,44 +230,72 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "ATTRIBUTES": "attributes", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, ('meta_include',): { + "ORIGIN": "origin", "PAGE": "page", "ALL": "all", "ALL": "ALL" }, }, 'openapi_types': { - 'user_id': + 'workspace_id': + (str,), + 'origin': (str,), 'filter': (str,), + 'include': + ([str],), 'page': (int,), 'size': (int,), 'sort': ([str],), + 'x_gdc_validate_relations': + (bool,), 'meta_include': ([str],), }, 'attribute_map': { - 'user_id': 'userId', + 'workspace_id': 'workspaceId', + 'origin': 'origin', 'filter': 'filter', + 'include': 'include', 'page': 'page', 'size': 'size', 'sort': 'sort', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', 'meta_include': 'metaInclude', }, 'location_map': { - 'user_id': 'path', + 'workspace_id': 'path', + 'origin': 'query', 'filter': 'query', + 'include': 'query', 'page': 'query', 'size': 'query', 'sort': 'query', + 'x_gdc_validate_relations': 'header', 'meta_include': 'query', }, 'collection_format_map': { + 'include': 'csv', 'sort': 'multi', 'meta_include': 'csv', } @@ -375,30 +309,32 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_user_settings_endpoint = _Endpoint( + self.get_entity_attribute_hierarchies_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiUserSettingOutList,), + 'response_type': (JsonApiAttributeHierarchyOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings', - 'operation_id': 'get_all_entities_user_settings', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}', + 'operation_id': 'get_entity_attribute_hierarchies', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ - 'user_id', + 'workspace_id', + 'object_id', 'filter', - 'page', - 'size', - 'sort', + 'include', + 'x_gdc_validate_relations', 'meta_include', ], 'required': [ - 'user_id', + 'workspace_id', + 'object_id', ], 'nullable': [ ], 'enum': [ + 'include', 'meta_include', ], 'validation': [ @@ -412,45 +348,53 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "ATTRIBUTES": "attributes", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, ('meta_include',): { - "PAGE": "page", + "ORIGIN": "origin", "ALL": "all", "ALL": "ALL" }, }, 'openapi_types': { - 'user_id': + 'workspace_id': + (str,), + 'object_id': (str,), 'filter': (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': + 'include': ([str],), + 'x_gdc_validate_relations': + (bool,), 'meta_include': ([str],), }, 'attribute_map': { - 'user_id': 'userId', + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', + 'include': 'include', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', 'meta_include': 'metaInclude', }, 'location_map': { - 'user_id': 'path', + 'workspace_id': 'path', + 'object_id': 'path', 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', + 'include': 'query', + 'x_gdc_validate_relations': 'header', 'meta_include': 'query', }, 'collection_format_map': { - 'sort': 'multi', + 'include': 'csv', 'meta_include': 'csv', } }, @@ -463,63 +407,76 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_api_tokens_endpoint = _Endpoint( + self.patch_entity_attribute_hierarchies_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiApiTokenOutDocument,), + 'response_type': (JsonApiAttributeHierarchyOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/apiTokens/{id}', - 'operation_id': 'get_entity_api_tokens', - 'http_method': 'GET', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}', + 'operation_id': 'patch_entity_attribute_hierarchies', + 'http_method': 'PATCH', 'servers': None, }, params_map={ 'all': [ - 'user_id', - 'id', + 'workspace_id', + 'object_id', + 'json_api_attribute_hierarchy_patch_document', 'filter', + 'include', ], 'required': [ - 'user_id', - 'id', + 'workspace_id', + 'object_id', + 'json_api_attribute_hierarchy_patch_document', ], 'nullable': [ ], 'enum': [ + 'include', ], 'validation': [ - 'id', ] }, root_map={ 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, }, 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "ATTRIBUTES": "attributes", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, }, 'openapi_types': { - 'user_id': + 'workspace_id': (str,), - 'id': + 'object_id': (str,), + 'json_api_attribute_hierarchy_patch_document': + (JsonApiAttributeHierarchyPatchDocument,), 'filter': (str,), + 'include': + ([str],), }, 'attribute_map': { - 'user_id': 'userId', - 'id': 'id', + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', 'filter': 'filter', + 'include': 'include', }, 'location_map': { - 'user_id': 'path', - 'id': 'path', + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_attribute_hierarchy_patch_document': 'body', 'filter': 'query', + 'include': 'query', }, 'collection_format_map': { + 'include': 'csv', } }, headers_map={ @@ -527,65 +484,72 @@ def __init__(self, api_client=None): 'application/json', 'application/vnd.gooddata.api+json' ], - 'content_type': [], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] }, api_client=api_client ) - self.get_entity_user_settings_endpoint = _Endpoint( + self.search_entities_attribute_hierarchies_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiUserSettingOutDocument,), + 'response_type': (JsonApiAttributeHierarchyOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings/{id}', - 'operation_id': 'get_entity_user_settings', - 'http_method': 'GET', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search', + 'operation_id': 'search_entities_attribute_hierarchies', + 'http_method': 'POST', 'servers': None, }, params_map={ 'all': [ - 'user_id', - 'id', - 'filter', + 'workspace_id', + 'entity_search_body', + 'origin', + 'x_gdc_validate_relations', ], 'required': [ - 'user_id', - 'id', + 'workspace_id', + 'entity_search_body', ], 'nullable': [ ], 'enum': [ + 'origin', ], 'validation': [ - 'id', ] }, root_map={ 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, }, 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, }, 'openapi_types': { - 'user_id': - (str,), - 'id': + 'workspace_id': (str,), - 'filter': + 'entity_search_body': + (EntitySearchBody,), + 'origin': (str,), + 'x_gdc_validate_relations': + (bool,), }, 'attribute_map': { - 'user_id': 'userId', - 'id': 'id', - 'filter': 'filter', + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', }, 'location_map': { - 'user_id': 'path', - 'id': 'path', - 'filter': 'query', + 'workspace_id': 'path', + 'entity_search_body': 'body', + 'origin': 'query', + 'x_gdc_validate_relations': 'header', }, 'collection_format_map': { } @@ -595,72 +559,82 @@ def __init__(self, api_client=None): 'application/json', 'application/vnd.gooddata.api+json' ], - 'content_type': [], + 'content_type': [ + 'application/json' + ] }, api_client=api_client ) - self.update_entity_user_settings_endpoint = _Endpoint( + self.update_entity_attribute_hierarchies_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiUserSettingOutDocument,), + 'response_type': (JsonApiAttributeHierarchyOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings/{id}', - 'operation_id': 'update_entity_user_settings', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}', + 'operation_id': 'update_entity_attribute_hierarchies', 'http_method': 'PUT', 'servers': None, }, params_map={ 'all': [ - 'user_id', - 'id', - 'json_api_user_setting_in_document', + 'workspace_id', + 'object_id', + 'json_api_attribute_hierarchy_in_document', 'filter', + 'include', ], 'required': [ - 'user_id', - 'id', - 'json_api_user_setting_in_document', + 'workspace_id', + 'object_id', + 'json_api_attribute_hierarchy_in_document', ], 'nullable': [ ], 'enum': [ + 'include', ], 'validation': [ - 'id', ] }, root_map={ 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, }, 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "ATTRIBUTES": "attributes", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, }, 'openapi_types': { - 'user_id': + 'workspace_id': (str,), - 'id': + 'object_id': (str,), - 'json_api_user_setting_in_document': - (JsonApiUserSettingInDocument,), + 'json_api_attribute_hierarchy_in_document': + (JsonApiAttributeHierarchyInDocument,), 'filter': (str,), + 'include': + ([str],), }, 'attribute_map': { - 'user_id': 'userId', - 'id': 'id', + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', 'filter': 'filter', + 'include': 'include', }, 'location_map': { - 'user_id': 'path', - 'id': 'path', - 'json_api_user_setting_in_document': 'body', + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_attribute_hierarchy_in_document': 'body', 'filter': 'query', + 'include': 'query', }, 'collection_format_map': { + 'include': 'csv', } }, headers_map={ @@ -676,111 +650,27 @@ def __init__(self, api_client=None): api_client=api_client ) - def create_entity_api_tokens( - self, - user_id, - json_api_api_token_in_document, - **kwargs - ): - """Post a new API token for the user # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_api_tokens(user_id, json_api_api_token_in_document, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - json_api_api_token_in_document (JsonApiApiTokenInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiApiTokenOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['json_api_api_token_in_document'] = \ - json_api_api_token_in_document - return self.create_entity_api_tokens_endpoint.call_with_http_info(**kwargs) - - def create_entity_user_settings( + def create_entity_attribute_hierarchies( self, - user_id, - json_api_user_setting_in_document, + workspace_id, + json_api_attribute_hierarchy_in_document, **kwargs ): - """Post new user settings for the user # noqa: E501 + """Post Attribute Hierarchies # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_user_settings(user_id, json_api_user_setting_in_document, async_req=True) + >>> thread = api.create_entity_attribute_hierarchies(workspace_id, json_api_attribute_hierarchy_in_document, async_req=True) >>> result = thread.get() Args: - user_id (str): - json_api_user_setting_in_document (JsonApiUserSettingInDocument): + workspace_id (str): + json_api_attribute_hierarchy_in_document (JsonApiAttributeHierarchyInDocument): Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -813,94 +703,7 @@ def create_entity_user_settings( async_req (bool): execute request asynchronously Returns: - JsonApiUserSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['json_api_user_setting_in_document'] = \ - json_api_user_setting_in_document - return self.create_entity_user_settings_endpoint.call_with_http_info(**kwargs) - - def delete_entity_api_tokens( - self, - user_id, - id, - **kwargs - ): - """Delete an API Token for a user # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_api_tokens(user_id, id, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None + JsonApiAttributeHierarchyOutDocument If the method is called asynchronously, returns the request thread. """ @@ -929,29 +732,29 @@ def delete_entity_api_tokens( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['id'] = \ - id - return self.delete_entity_api_tokens_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['json_api_attribute_hierarchy_in_document'] = \ + json_api_attribute_hierarchy_in_document + return self.create_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) - def delete_entity_user_settings( + def delete_entity_attribute_hierarchies( self, - user_id, - id, + workspace_id, + object_id, **kwargs ): - """Delete a setting for a user # noqa: E501 + """Delete an Attribute Hierarchy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_user_settings(user_id, id, async_req=True) + >>> thread = api.delete_entity_attribute_hierarchies(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: - user_id (str): - id (str): + workspace_id (str): + object_id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -1016,33 +819,36 @@ def delete_entity_user_settings( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['id'] = \ - id - return self.delete_entity_user_settings_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) - def get_all_entities_api_tokens( + def get_all_entities_attribute_hierarchies( self, - user_id, + workspace_id, **kwargs ): - """List all api tokens for a user # noqa: E501 + """Get all Attribute Hierarchies # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_api_tokens(user_id, async_req=True) + >>> thread = api.get_all_entities_attribute_hierarchies(workspace_id, async_req=True) >>> result = thread.get() Args: - user_id (str): + workspace_id (str): Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -1076,7 +882,7 @@ def get_all_entities_api_tokens( async_req (bool): execute request asynchronously Returns: - JsonApiApiTokenOutList + JsonApiAttributeHierarchyOutList If the method is called asynchronously, returns the request thread. """ @@ -1105,31 +911,32 @@ def get_all_entities_api_tokens( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - return self.get_all_entities_api_tokens_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) - def get_all_entities_user_settings( + def get_entity_attribute_hierarchies( self, - user_id, + workspace_id, + object_id, **kwargs ): - """List all settings for a user # noqa: E501 + """Get an Attribute Hierarchy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_user_settings(user_id, async_req=True) + >>> thread = api.get_entity_attribute_hierarchies(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: - user_id (str): + workspace_id (str): + object_id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -1163,7 +970,7 @@ def get_all_entities_user_settings( async_req (bool): execute request asynchronously Returns: - JsonApiUserSettingOutList + JsonApiAttributeHierarchyOutDocument If the method is called asynchronously, returns the request thread. """ @@ -1192,30 +999,35 @@ def get_all_entities_user_settings( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - return self.get_all_entities_user_settings_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) - def get_entity_api_tokens( + def patch_entity_attribute_hierarchies( self, - user_id, - id, + workspace_id, + object_id, + json_api_attribute_hierarchy_patch_document, **kwargs ): - """Get an API Token for a user # noqa: E501 + """Patch an Attribute Hierarchy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_api_tokens(user_id, id, async_req=True) + >>> thread = api.patch_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_patch_document, async_req=True) >>> result = thread.get() Args: - user_id (str): - id (str): + workspace_id (str): + object_id (str): + json_api_attribute_hierarchy_patch_document (JsonApiAttributeHierarchyPatchDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -1248,7 +1060,7 @@ def get_entity_api_tokens( async_req (bool): execute request asynchronously Returns: - JsonApiApiTokenOutDocument + JsonApiAttributeHierarchyOutDocument If the method is called asynchronously, returns the request thread. """ @@ -1277,32 +1089,35 @@ def get_entity_api_tokens( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['id'] = \ - id - return self.get_entity_api_tokens_endpoint.call_with_http_info(**kwargs) - - def get_entity_user_settings( + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_attribute_hierarchy_patch_document'] = \ + json_api_attribute_hierarchy_patch_document + return self.patch_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) + + def search_entities_attribute_hierarchies( self, - user_id, - id, + workspace_id, + entity_search_body, **kwargs ): - """Get a setting for a user # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_user_settings(user_id, id, async_req=True) + >>> thread = api.search_entities_attribute_hierarchies(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: - user_id (str): - id (str): + workspace_id (str): + entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + origin (str): [optional] if omitted the server will use the default value of "ALL" + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -1335,7 +1150,7 @@ def get_entity_user_settings( async_req (bool): execute request asynchronously Returns: - JsonApiUserSettingOutDocument + JsonApiAttributeHierarchyOutList If the method is called asynchronously, returns the request thread. """ @@ -1364,34 +1179,35 @@ def get_entity_user_settings( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['id'] = \ - id - return self.get_entity_user_settings_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['entity_search_body'] = \ + entity_search_body + return self.search_entities_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) - def update_entity_user_settings( + def update_entity_attribute_hierarchies( self, - user_id, - id, - json_api_user_setting_in_document, + workspace_id, + object_id, + json_api_attribute_hierarchy_in_document, **kwargs ): - """Put new user settings for the user # noqa: E501 + """Put an Attribute Hierarchy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_user_settings(user_id, id, json_api_user_setting_in_document, async_req=True) + >>> thread = api.update_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_in_document, async_req=True) >>> result = thread.get() Args: - user_id (str): - id (str): - json_api_user_setting_in_document (JsonApiUserSettingInDocument): + workspace_id (str): + object_id (str): + json_api_attribute_hierarchy_in_document (JsonApiAttributeHierarchyInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -1424,7 +1240,7 @@ def update_entity_user_settings( async_req (bool): execute request asynchronously Returns: - JsonApiUserSettingOutDocument + JsonApiAttributeHierarchyOutDocument If the method is called asynchronously, returns the request thread. """ @@ -1453,11 +1269,11 @@ def update_entity_user_settings( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['id'] = \ - id - kwargs['json_api_user_setting_in_document'] = \ - json_api_user_setting_in_document - return self.update_entity_user_settings_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_attribute_hierarchy_in_document'] = \ + json_api_attribute_hierarchy_in_document + return self.update_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) diff --git a/gooddata-api-client/gooddata_api_client/api/attributes_api.py b/gooddata-api-client/gooddata_api_client/api/attributes_api.py index d75ad230d..0c6913a5b 100644 --- a/gooddata-api-client/gooddata_api_client/api/attributes_api.py +++ b/gooddata-api-client/gooddata_api_client/api/attributes_api.py @@ -698,7 +698,7 @@ def search_entities_attributes( entity_search_body, **kwargs ): - """Search request for Attribute # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/automation_controller_api.py b/gooddata-api-client/gooddata_api_client/api/automation_controller_api.py new file mode 100644 index 000000000..15cbaac6e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/automation_controller_api.py @@ -0,0 +1,1314 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint +from gooddata_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from gooddata_api_client.model.entity_search_body import EntitySearchBody +from gooddata_api_client.model.json_api_automation_in_document import JsonApiAutomationInDocument +from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument +from gooddata_api_client.model.json_api_automation_out_list import JsonApiAutomationOutList +from gooddata_api_client.model.json_api_automation_patch_document import JsonApiAutomationPatchDocument + + +class AutomationControllerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_entity_automations_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiAutomationOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automations', + 'operation_id': 'create_entity_automations', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_automation_in_document', + 'include', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_automation_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "NOTIFICATIONCHANNELS": "notificationChannels", + "ANALYTICALDASHBOARDS": "analyticalDashboards", + "USERIDENTIFIERS": "userIdentifiers", + "EXPORTDEFINITIONS": "exportDefinitions", + "USERS": "users", + "AUTOMATIONRESULTS": "automationResults", + "NOTIFICATIONCHANNEL": "notificationChannel", + "ANALYTICALDASHBOARD": "analyticalDashboard", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "RECIPIENTS": "recipients", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'json_api_automation_in_document': + (JsonApiAutomationInDocument,), + 'include': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'include': 'include', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_automation_in_document': 'body', + 'include': 'query', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.delete_entity_automations_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}', + 'operation_id': 'delete_entity_automations', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_entities_automations_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiAutomationOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automations', + 'operation_id': 'get_all_entities_automations', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'origin', + 'filter', + 'include', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('include',): { + + "NOTIFICATIONCHANNELS": "notificationChannels", + "ANALYTICALDASHBOARDS": "analyticalDashboards", + "USERIDENTIFIERS": "userIdentifiers", + "EXPORTDEFINITIONS": "exportDefinitions", + "USERS": "users", + "AUTOMATIONRESULTS": "automationResults", + "NOTIFICATIONCHANNEL": "notificationChannel", + "ANALYTICALDASHBOARD": "analyticalDashboard", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "RECIPIENTS": "recipients", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'origin': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'filter': 'filter', + 'include': 'include', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'origin': 'query', + 'filter': 'query', + 'include': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_automations_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiAutomationOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}', + 'operation_id': 'get_entity_automations', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + 'include', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "NOTIFICATIONCHANNELS": "notificationChannels", + "ANALYTICALDASHBOARDS": "analyticalDashboards", + "USERIDENTIFIERS": "userIdentifiers", + "EXPORTDEFINITIONS": "exportDefinitions", + "USERS": "users", + "AUTOMATIONRESULTS": "automationResults", + "NOTIFICATIONCHANNEL": "notificationChannel", + "ANALYTICALDASHBOARD": "analyticalDashboard", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "RECIPIENTS": "recipients", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + 'include': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.patch_entity_automations_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiAutomationOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}', + 'operation_id': 'patch_entity_automations', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_automation_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_automation_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "NOTIFICATIONCHANNELS": "notificationChannels", + "ANALYTICALDASHBOARDS": "analyticalDashboards", + "USERIDENTIFIERS": "userIdentifiers", + "EXPORTDEFINITIONS": "exportDefinitions", + "USERS": "users", + "AUTOMATIONRESULTS": "automationResults", + "NOTIFICATIONCHANNEL": "notificationChannel", + "ANALYTICALDASHBOARD": "analyticalDashboard", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "RECIPIENTS": "recipients", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_automation_patch_document': + (JsonApiAutomationPatchDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_automation_patch_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.search_entities_automations_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiAutomationOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automations/search', + 'operation_id': 'search_entities_automations', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'entity_search_body', + 'origin', + 'x_gdc_validate_relations', + ], + 'required': [ + 'workspace_id', + 'entity_search_body', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'entity_search_body': + (EntitySearchBody,), + 'origin': + (str,), + 'x_gdc_validate_relations': + (bool,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + }, + 'location_map': { + 'workspace_id': 'path', + 'entity_search_body': 'body', + 'origin': 'query', + 'x_gdc_validate_relations': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_entity_automations_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiAutomationOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}', + 'operation_id': 'update_entity_automations', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_automation_in_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_automation_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "NOTIFICATIONCHANNELS": "notificationChannels", + "ANALYTICALDASHBOARDS": "analyticalDashboards", + "USERIDENTIFIERS": "userIdentifiers", + "EXPORTDEFINITIONS": "exportDefinitions", + "USERS": "users", + "AUTOMATIONRESULTS": "automationResults", + "NOTIFICATIONCHANNEL": "notificationChannel", + "ANALYTICALDASHBOARD": "analyticalDashboard", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "RECIPIENTS": "recipients", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_automation_in_document': + (JsonApiAutomationInDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_automation_in_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + + def create_entity_automations( + self, + workspace_id, + json_api_automation_in_document, + **kwargs + ): + """Post Automations # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_automations(workspace_id, json_api_automation_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_automation_in_document (JsonApiAutomationInDocument): + + Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiAutomationOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['json_api_automation_in_document'] = \ + json_api_automation_in_document + return self.create_entity_automations_endpoint.call_with_http_info(**kwargs) + + def delete_entity_automations( + self, + workspace_id, + object_id, + **kwargs + ): + """Delete an Automation # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_entity_automations(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_automations_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_automations( + self, + workspace_id, + **kwargs + ): + """Get all Automations # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_automations(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiAutomationOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_automations_endpoint.call_with_http_info(**kwargs) + + def get_entity_automations( + self, + workspace_id, + object_id, + **kwargs + ): + """Get an Automation # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_automations(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiAutomationOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_automations_endpoint.call_with_http_info(**kwargs) + + def patch_entity_automations( + self, + workspace_id, + object_id, + json_api_automation_patch_document, + **kwargs + ): + """Patch an Automation # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_automation_patch_document (JsonApiAutomationPatchDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiAutomationOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_automation_patch_document'] = \ + json_api_automation_patch_document + return self.patch_entity_automations_endpoint.call_with_http_info(**kwargs) + + def search_entities_automations( + self, + workspace_id, + entity_search_body, + **kwargs + ): + """The search endpoint (beta) # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_entities_automations(workspace_id, entity_search_body, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiAutomationOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['entity_search_body'] = \ + entity_search_body + return self.search_entities_automations_endpoint.call_with_http_info(**kwargs) + + def update_entity_automations( + self, + workspace_id, + object_id, + json_api_automation_in_document, + **kwargs + ): + """Put an Automation # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_entity_automations(workspace_id, object_id, json_api_automation_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_automation_in_document (JsonApiAutomationInDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiAutomationOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_automation_in_document'] = \ + json_api_automation_in_document + return self.update_entity_automations_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/automations_api.py b/gooddata-api-client/gooddata_api_client/api/automations_api.py index 7227d7ea6..82e49ce93 100644 --- a/gooddata-api-client/gooddata_api_client/api/automations_api.py +++ b/gooddata-api-client/gooddata_api_client/api/automations_api.py @@ -2683,7 +2683,7 @@ def search_entities_automations( entity_search_body, **kwargs ): - """Search request for Automation # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/computation_api.py b/gooddata-api-client/gooddata_api_client/api/computation_api.py index 30f0a5ca6..c5d9d339f 100644 --- a/gooddata-api-client/gooddata_api_client/api/computation_api.py +++ b/gooddata-api-client/gooddata_api_client/api/computation_api.py @@ -1031,10 +1031,10 @@ def __init__(self, api_client=None): 'all': [ 'workspace_id', 'result_id', + 'x_gdc_cancel_token', 'offset', 'limit', 'excluded_total_dimensions', - 'x_gdc_cancel_token', ], 'required': [ 'workspace_id', @@ -1064,30 +1064,30 @@ def __init__(self, api_client=None): (str,), 'result_id': (str,), + 'x_gdc_cancel_token': + (str,), 'offset': ([int],), 'limit': ([int],), 'excluded_total_dimensions': ([str],), - 'x_gdc_cancel_token': - (str,), }, 'attribute_map': { 'workspace_id': 'workspaceId', 'result_id': 'resultId', + 'x_gdc_cancel_token': 'X-GDC-CANCEL-TOKEN', 'offset': 'offset', 'limit': 'limit', 'excluded_total_dimensions': 'excludedTotalDimensions', - 'x_gdc_cancel_token': 'X-GDC-CANCEL-TOKEN', }, 'location_map': { 'workspace_id': 'path', 'result_id': 'path', + 'x_gdc_cancel_token': 'header', 'offset': 'query', 'limit': 'query', 'excluded_total_dimensions': 'query', - 'x_gdc_cancel_token': 'header', }, 'collection_format_map': { 'offset': 'csv', @@ -1097,7 +1097,9 @@ def __init__(self, api_client=None): }, headers_map={ 'accept': [ - 'application/json' + 'application/json', + 'application/vnd.apache.arrow.file', + 'application/vnd.apache.arrow.stream' ], 'content_type': [], }, @@ -2342,7 +2344,7 @@ def retrieve_result( ): """Get a single execution result # noqa: E501 - Gets a single execution result. # noqa: E501 + Gets a single execution result. Note that the Arrow File and Arrow Stream content types are currently in BETA. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2354,10 +2356,10 @@ def retrieve_result( result_id (str): Result ID Keyword Args: + x_gdc_cancel_token (str): [optional] offset ([int]): Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM.. [optional] if omitted the server will use the default value of [] limit ([int]): Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM.. [optional] if omitted the server will use the default value of [] excluded_total_dimensions ([str]): Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions.. [optional] if omitted the server will use the default value of [] - x_gdc_cancel_token (str): [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object diff --git a/gooddata-api-client/gooddata_api_client/api/cookie_security_configuration_controller_api.py b/gooddata-api-client/gooddata_api_client/api/cookie_security_configuration_controller_api.py new file mode 100644 index 000000000..9b5647dcc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/cookie_security_configuration_controller_api.py @@ -0,0 +1,500 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint +from gooddata_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from gooddata_api_client.model.json_api_cookie_security_configuration_in_document import JsonApiCookieSecurityConfigurationInDocument +from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.model.json_api_cookie_security_configuration_patch_document import JsonApiCookieSecurityConfigurationPatchDocument + + +class CookieSecurityConfigurationControllerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_entity_cookie_security_configurations_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiCookieSecurityConfigurationOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/admin/cookieSecurityConfigurations/{id}', + 'operation_id': 'get_entity_cookie_security_configurations', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'filter', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'filter': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + }, + 'location_map': { + 'id': 'path', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.patch_entity_cookie_security_configurations_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiCookieSecurityConfigurationOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/admin/cookieSecurityConfigurations/{id}', + 'operation_id': 'patch_entity_cookie_security_configurations', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'json_api_cookie_security_configuration_patch_document', + 'filter', + ], + 'required': [ + 'id', + 'json_api_cookie_security_configuration_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'json_api_cookie_security_configuration_patch_document': + (JsonApiCookieSecurityConfigurationPatchDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + }, + 'location_map': { + 'id': 'path', + 'json_api_cookie_security_configuration_patch_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.update_entity_cookie_security_configurations_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiCookieSecurityConfigurationOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/admin/cookieSecurityConfigurations/{id}', + 'operation_id': 'update_entity_cookie_security_configurations', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'json_api_cookie_security_configuration_in_document', + 'filter', + ], + 'required': [ + 'id', + 'json_api_cookie_security_configuration_in_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'json_api_cookie_security_configuration_in_document': + (JsonApiCookieSecurityConfigurationInDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + }, + 'location_map': { + 'id': 'path', + 'json_api_cookie_security_configuration_in_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + + def get_entity_cookie_security_configurations( + self, + id, + **kwargs + ): + """Get CookieSecurityConfiguration # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_cookie_security_configurations(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiCookieSecurityConfigurationOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_entity_cookie_security_configurations_endpoint.call_with_http_info(**kwargs) + + def patch_entity_cookie_security_configurations( + self, + id, + json_api_cookie_security_configuration_patch_document, + **kwargs + ): + """Patch CookieSecurityConfiguration # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_patch_document, async_req=True) + >>> result = thread.get() + + Args: + id (str): + json_api_cookie_security_configuration_patch_document (JsonApiCookieSecurityConfigurationPatchDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiCookieSecurityConfigurationOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + kwargs['json_api_cookie_security_configuration_patch_document'] = \ + json_api_cookie_security_configuration_patch_document + return self.patch_entity_cookie_security_configurations_endpoint.call_with_http_info(**kwargs) + + def update_entity_cookie_security_configurations( + self, + id, + json_api_cookie_security_configuration_in_document, + **kwargs + ): + """Put CookieSecurityConfiguration # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_in_document, async_req=True) + >>> result = thread.get() + + Args: + id (str): + json_api_cookie_security_configuration_in_document (JsonApiCookieSecurityConfigurationInDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiCookieSecurityConfigurationOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + kwargs['json_api_cookie_security_configuration_in_document'] = \ + json_api_cookie_security_configuration_in_document + return self.update_entity_cookie_security_configurations_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/custom_application_setting_controller_api.py b/gooddata-api-client/gooddata_api_client/api/custom_application_setting_controller_api.py new file mode 100644 index 000000000..a89f8f7f2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/custom_application_setting_controller_api.py @@ -0,0 +1,1200 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint +from gooddata_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from gooddata_api_client.model.entity_search_body import EntitySearchBody +from gooddata_api_client.model.json_api_custom_application_setting_in_document import JsonApiCustomApplicationSettingInDocument +from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +from gooddata_api_client.model.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList +from gooddata_api_client.model.json_api_custom_application_setting_patch_document import JsonApiCustomApplicationSettingPatchDocument +from gooddata_api_client.model.json_api_custom_application_setting_post_optional_id_document import JsonApiCustomApplicationSettingPostOptionalIdDocument + + +class CustomApplicationSettingControllerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_entity_custom_application_settings_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiCustomApplicationSettingOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings', + 'operation_id': 'create_entity_custom_application_settings', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_custom_application_setting_post_optional_id_document', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_custom_application_setting_post_optional_id_document', + ], + 'nullable': [ + ], + 'enum': [ + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'json_api_custom_application_setting_post_optional_id_document': + (JsonApiCustomApplicationSettingPostOptionalIdDocument,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_custom_application_setting_post_optional_id_document': 'body', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.delete_entity_custom_application_settings_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', + 'operation_id': 'delete_entity_custom_application_settings', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_entities_custom_application_settings_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiCustomApplicationSettingOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings', + 'operation_id': 'get_all_entities_custom_application_settings', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'origin', + 'filter', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'origin': + (str,), + 'filter': + (str,), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'filter': 'filter', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'origin': 'query', + 'filter': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_custom_application_settings_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiCustomApplicationSettingOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', + 'operation_id': 'get_entity_custom_application_settings', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.patch_entity_custom_application_settings_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiCustomApplicationSettingOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', + 'operation_id': 'patch_entity_custom_application_settings', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_custom_application_setting_patch_document', + 'filter', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_custom_application_setting_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_custom_application_setting_patch_document': + (JsonApiCustomApplicationSettingPatchDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_custom_application_setting_patch_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.search_entities_custom_application_settings_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiCustomApplicationSettingOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search', + 'operation_id': 'search_entities_custom_application_settings', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'entity_search_body', + 'origin', + 'x_gdc_validate_relations', + ], + 'required': [ + 'workspace_id', + 'entity_search_body', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'entity_search_body': + (EntitySearchBody,), + 'origin': + (str,), + 'x_gdc_validate_relations': + (bool,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + }, + 'location_map': { + 'workspace_id': 'path', + 'entity_search_body': 'body', + 'origin': 'query', + 'x_gdc_validate_relations': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_entity_custom_application_settings_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiCustomApplicationSettingOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', + 'operation_id': 'update_entity_custom_application_settings', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_custom_application_setting_in_document', + 'filter', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_custom_application_setting_in_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_custom_application_setting_in_document': + (JsonApiCustomApplicationSettingInDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_custom_application_setting_in_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + + def create_entity_custom_application_settings( + self, + workspace_id, + json_api_custom_application_setting_post_optional_id_document, + **kwargs + ): + """Post Custom Application Settings # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_custom_application_settings(workspace_id, json_api_custom_application_setting_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_custom_application_setting_post_optional_id_document (JsonApiCustomApplicationSettingPostOptionalIdDocument): + + Keyword Args: + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiCustomApplicationSettingOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['json_api_custom_application_setting_post_optional_id_document'] = \ + json_api_custom_application_setting_post_optional_id_document + return self.create_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) + + def delete_entity_custom_application_settings( + self, + workspace_id, + object_id, + **kwargs + ): + """Delete a Custom Application Setting # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_entity_custom_application_settings(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_custom_application_settings( + self, + workspace_id, + **kwargs + ): + """Get all Custom Application Settings # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_custom_application_settings(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiCustomApplicationSettingOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_custom_application_settings_endpoint.call_with_http_info(**kwargs) + + def get_entity_custom_application_settings( + self, + workspace_id, + object_id, + **kwargs + ): + """Get a Custom Application Setting # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_custom_application_settings(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiCustomApplicationSettingOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) + + def patch_entity_custom_application_settings( + self, + workspace_id, + object_id, + json_api_custom_application_setting_patch_document, + **kwargs + ): + """Patch a Custom Application Setting # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_custom_application_setting_patch_document (JsonApiCustomApplicationSettingPatchDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiCustomApplicationSettingOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_custom_application_setting_patch_document'] = \ + json_api_custom_application_setting_patch_document + return self.patch_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) + + def search_entities_custom_application_settings( + self, + workspace_id, + entity_search_body, + **kwargs + ): + """The search endpoint (beta) # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_entities_custom_application_settings(workspace_id, entity_search_body, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiCustomApplicationSettingOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['entity_search_body'] = \ + entity_search_body + return self.search_entities_custom_application_settings_endpoint.call_with_http_info(**kwargs) + + def update_entity_custom_application_settings( + self, + workspace_id, + object_id, + json_api_custom_application_setting_in_document, + **kwargs + ): + """Put a Custom Application Setting # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_custom_application_setting_in_document (JsonApiCustomApplicationSettingInDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiCustomApplicationSettingOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_custom_application_setting_in_document'] = \ + json_api_custom_application_setting_in_document + return self.update_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/custom_geo_collection_controller_api.py b/gooddata-api-client/gooddata_api_client/api/custom_geo_collection_controller_api.py new file mode 100644 index 000000000..65abbddec --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/custom_geo_collection_controller_api.py @@ -0,0 +1,940 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint +from gooddata_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from gooddata_api_client.model.json_api_custom_geo_collection_in_document import JsonApiCustomGeoCollectionInDocument +from gooddata_api_client.model.json_api_custom_geo_collection_out_document import JsonApiCustomGeoCollectionOutDocument +from gooddata_api_client.model.json_api_custom_geo_collection_out_list import JsonApiCustomGeoCollectionOutList +from gooddata_api_client.model.json_api_custom_geo_collection_patch_document import JsonApiCustomGeoCollectionPatchDocument + + +class CustomGeoCollectionControllerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_entity_custom_geo_collections_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiCustomGeoCollectionOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/customGeoCollections', + 'operation_id': 'create_entity_custom_geo_collections', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'json_api_custom_geo_collection_in_document', + ], + 'required': [ + 'json_api_custom_geo_collection_in_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'json_api_custom_geo_collection_in_document': + (JsonApiCustomGeoCollectionInDocument,), + }, + 'attribute_map': { + }, + 'location_map': { + 'json_api_custom_geo_collection_in_document': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.delete_entity_custom_geo_collections_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/customGeoCollections/{id}', + 'operation_id': 'delete_entity_custom_geo_collections', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'filter', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'filter': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + }, + 'location_map': { + 'id': 'path', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_entities_custom_geo_collections_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiCustomGeoCollectionOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/customGeoCollections', + 'operation_id': 'get_all_entities_custom_geo_collections', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'filter', + 'page', + 'size', + 'sort', + 'meta_include', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('meta_include',): { + + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'filter': + (str,), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'filter': 'filter', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'filter': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_custom_geo_collections_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiCustomGeoCollectionOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/customGeoCollections/{id}', + 'operation_id': 'get_entity_custom_geo_collections', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'filter', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'filter': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + }, + 'location_map': { + 'id': 'path', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.patch_entity_custom_geo_collections_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiCustomGeoCollectionOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/customGeoCollections/{id}', + 'operation_id': 'patch_entity_custom_geo_collections', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'json_api_custom_geo_collection_patch_document', + 'filter', + ], + 'required': [ + 'id', + 'json_api_custom_geo_collection_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'json_api_custom_geo_collection_patch_document': + (JsonApiCustomGeoCollectionPatchDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + }, + 'location_map': { + 'id': 'path', + 'json_api_custom_geo_collection_patch_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.update_entity_custom_geo_collections_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiCustomGeoCollectionOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/customGeoCollections/{id}', + 'operation_id': 'update_entity_custom_geo_collections', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'json_api_custom_geo_collection_in_document', + 'filter', + ], + 'required': [ + 'id', + 'json_api_custom_geo_collection_in_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'json_api_custom_geo_collection_in_document': + (JsonApiCustomGeoCollectionInDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + }, + 'location_map': { + 'id': 'path', + 'json_api_custom_geo_collection_in_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + + def create_entity_custom_geo_collections( + self, + json_api_custom_geo_collection_in_document, + **kwargs + ): + """Post Custom Geo Collections # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_custom_geo_collections(json_api_custom_geo_collection_in_document, async_req=True) + >>> result = thread.get() + + Args: + json_api_custom_geo_collection_in_document (JsonApiCustomGeoCollectionInDocument): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiCustomGeoCollectionOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['json_api_custom_geo_collection_in_document'] = \ + json_api_custom_geo_collection_in_document + return self.create_entity_custom_geo_collections_endpoint.call_with_http_info(**kwargs) + + def delete_entity_custom_geo_collections( + self, + id, + **kwargs + ): + """Delete Custom Geo Collection # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_entity_custom_geo_collections(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_entity_custom_geo_collections_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_custom_geo_collections( + self, + **kwargs + ): + """Get all Custom Geo Collections # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_custom_geo_collections(async_req=True) + >>> result = thread.get() + + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiCustomGeoCollectionOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_all_entities_custom_geo_collections_endpoint.call_with_http_info(**kwargs) + + def get_entity_custom_geo_collections( + self, + id, + **kwargs + ): + """Get Custom Geo Collection # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_custom_geo_collections(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiCustomGeoCollectionOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_entity_custom_geo_collections_endpoint.call_with_http_info(**kwargs) + + def patch_entity_custom_geo_collections( + self, + id, + json_api_custom_geo_collection_patch_document, + **kwargs + ): + """Patch Custom Geo Collection # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_entity_custom_geo_collections(id, json_api_custom_geo_collection_patch_document, async_req=True) + >>> result = thread.get() + + Args: + id (str): + json_api_custom_geo_collection_patch_document (JsonApiCustomGeoCollectionPatchDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiCustomGeoCollectionOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + kwargs['json_api_custom_geo_collection_patch_document'] = \ + json_api_custom_geo_collection_patch_document + return self.patch_entity_custom_geo_collections_endpoint.call_with_http_info(**kwargs) + + def update_entity_custom_geo_collections( + self, + id, + json_api_custom_geo_collection_in_document, + **kwargs + ): + """Put Custom Geo Collection # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_entity_custom_geo_collections(id, json_api_custom_geo_collection_in_document, async_req=True) + >>> result = thread.get() + + Args: + id (str): + json_api_custom_geo_collection_in_document (JsonApiCustomGeoCollectionInDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiCustomGeoCollectionOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + kwargs['json_api_custom_geo_collection_in_document'] = \ + json_api_custom_geo_collection_in_document + return self.update_entity_custom_geo_collections_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/dashboard_plugin_controller_api.py b/gooddata-api-client/gooddata_api_client/api/dashboard_plugin_controller_api.py new file mode 100644 index 000000000..1ea10bd41 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/dashboard_plugin_controller_api.py @@ -0,0 +1,1275 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint +from gooddata_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from gooddata_api_client.model.entity_search_body import EntitySearchBody +from gooddata_api_client.model.json_api_dashboard_plugin_in_document import JsonApiDashboardPluginInDocument +from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.model.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList +from gooddata_api_client.model.json_api_dashboard_plugin_patch_document import JsonApiDashboardPluginPatchDocument +from gooddata_api_client.model.json_api_dashboard_plugin_post_optional_id_document import JsonApiDashboardPluginPostOptionalIdDocument + + +class DashboardPluginControllerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_entity_dashboard_plugins_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiDashboardPluginOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins', + 'operation_id': 'create_entity_dashboard_plugins', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_dashboard_plugin_post_optional_id_document', + 'include', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_dashboard_plugin_post_optional_id_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'json_api_dashboard_plugin_post_optional_id_document': + (JsonApiDashboardPluginPostOptionalIdDocument,), + 'include': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'include': 'include', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_dashboard_plugin_post_optional_id_document': 'body', + 'include': 'query', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.delete_entity_dashboard_plugins_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', + 'operation_id': 'delete_entity_dashboard_plugins', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_entities_dashboard_plugins_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiDashboardPluginOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins', + 'operation_id': 'get_all_entities_dashboard_plugins', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'origin', + 'filter', + 'include', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'origin': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'filter': 'filter', + 'include': 'include', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'origin': 'query', + 'filter': 'query', + 'include': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_dashboard_plugins_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiDashboardPluginOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', + 'operation_id': 'get_entity_dashboard_plugins', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + 'include', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + 'include': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.patch_entity_dashboard_plugins_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiDashboardPluginOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', + 'operation_id': 'patch_entity_dashboard_plugins', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_dashboard_plugin_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_dashboard_plugin_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_dashboard_plugin_patch_document': + (JsonApiDashboardPluginPatchDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_dashboard_plugin_patch_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.search_entities_dashboard_plugins_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiDashboardPluginOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search', + 'operation_id': 'search_entities_dashboard_plugins', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'entity_search_body', + 'origin', + 'x_gdc_validate_relations', + ], + 'required': [ + 'workspace_id', + 'entity_search_body', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'entity_search_body': + (EntitySearchBody,), + 'origin': + (str,), + 'x_gdc_validate_relations': + (bool,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + }, + 'location_map': { + 'workspace_id': 'path', + 'entity_search_body': 'body', + 'origin': 'query', + 'x_gdc_validate_relations': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_entity_dashboard_plugins_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiDashboardPluginOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', + 'operation_id': 'update_entity_dashboard_plugins', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_dashboard_plugin_in_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_dashboard_plugin_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_dashboard_plugin_in_document': + (JsonApiDashboardPluginInDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_dashboard_plugin_in_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + + def create_entity_dashboard_plugins( + self, + workspace_id, + json_api_dashboard_plugin_post_optional_id_document, + **kwargs + ): + """Post Plugins # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_dashboard_plugins(workspace_id, json_api_dashboard_plugin_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_dashboard_plugin_post_optional_id_document (JsonApiDashboardPluginPostOptionalIdDocument): + + Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiDashboardPluginOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['json_api_dashboard_plugin_post_optional_id_document'] = \ + json_api_dashboard_plugin_post_optional_id_document + return self.create_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) + + def delete_entity_dashboard_plugins( + self, + workspace_id, + object_id, + **kwargs + ): + """Delete a Plugin # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_entity_dashboard_plugins(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_dashboard_plugins( + self, + workspace_id, + **kwargs + ): + """Get all Plugins # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_dashboard_plugins(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiDashboardPluginOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_dashboard_plugins_endpoint.call_with_http_info(**kwargs) + + def get_entity_dashboard_plugins( + self, + workspace_id, + object_id, + **kwargs + ): + """Get a Plugin # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_dashboard_plugins(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiDashboardPluginOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) + + def patch_entity_dashboard_plugins( + self, + workspace_id, + object_id, + json_api_dashboard_plugin_patch_document, + **kwargs + ): + """Patch a Plugin # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_dashboard_plugin_patch_document (JsonApiDashboardPluginPatchDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiDashboardPluginOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_dashboard_plugin_patch_document'] = \ + json_api_dashboard_plugin_patch_document + return self.patch_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) + + def search_entities_dashboard_plugins( + self, + workspace_id, + entity_search_body, + **kwargs + ): + """The search endpoint (beta) # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_entities_dashboard_plugins(workspace_id, entity_search_body, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiDashboardPluginOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['entity_search_body'] = \ + entity_search_body + return self.search_entities_dashboard_plugins_endpoint.call_with_http_info(**kwargs) + + def update_entity_dashboard_plugins( + self, + workspace_id, + object_id, + json_api_dashboard_plugin_in_document, + **kwargs + ): + """Put a Plugin # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_dashboard_plugin_in_document (JsonApiDashboardPluginInDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiDashboardPluginOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_dashboard_plugin_in_document'] = \ + json_api_dashboard_plugin_in_document + return self.update_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/dashboards_api.py b/gooddata-api-client/gooddata_api_client/api/dashboards_api.py index 5bd88d55d..8bb0ae946 100644 --- a/gooddata-api-client/gooddata_api_client/api/dashboards_api.py +++ b/gooddata-api-client/gooddata_api_client/api/dashboards_api.py @@ -1145,7 +1145,7 @@ def search_entities_analytical_dashboards( entity_search_body, **kwargs ): - """Search request for AnalyticalDashboard # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/data_filters_api.py b/gooddata-api-client/gooddata_api_client/api/data_filters_api.py index 6e1eb7c24..255f93c94 100644 --- a/gooddata-api-client/gooddata_api_client/api/data_filters_api.py +++ b/gooddata-api-client/gooddata_api_client/api/data_filters_api.py @@ -3398,7 +3398,7 @@ def search_entities_user_data_filters( entity_search_body, **kwargs ): - """Search request for UserDataFilter # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3486,7 +3486,7 @@ def search_entities_workspace_data_filter_settings( entity_search_body, **kwargs ): - """Search request for WorkspaceDataFilterSetting # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3574,7 +3574,7 @@ def search_entities_workspace_data_filters( entity_search_body, **kwargs ): - """Search request for WorkspaceDataFilter # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/organization_controller_api.py b/gooddata-api-client/gooddata_api_client/api/data_source_controller_api.py similarity index 71% rename from gooddata-api-client/gooddata_api_client/api/organization_controller_api.py rename to gooddata-api-client/gooddata_api_client/api/data_source_controller_api.py index 5d7e59c5a..2bad124d5 100644 --- a/gooddata-api-client/gooddata_api_client/api/organization_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/data_source_controller_api.py @@ -22,15 +22,13 @@ none_type, validate_and_convert_types ) -from gooddata_api_client.model.json_api_cookie_security_configuration_in_document import JsonApiCookieSecurityConfigurationInDocument -from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument -from gooddata_api_client.model.json_api_cookie_security_configuration_patch_document import JsonApiCookieSecurityConfigurationPatchDocument -from gooddata_api_client.model.json_api_organization_in_document import JsonApiOrganizationInDocument -from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument -from gooddata_api_client.model.json_api_organization_patch_document import JsonApiOrganizationPatchDocument +from gooddata_api_client.model.json_api_data_source_in_document import JsonApiDataSourceInDocument +from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.model.json_api_data_source_out_list import JsonApiDataSourceOutList +from gooddata_api_client.model.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument -class OrganizationControllerApi(object): +class DataSourceControllerApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech @@ -41,57 +39,61 @@ def __init__(self, api_client=None): if api_client is None: api_client = ApiClient() self.api_client = api_client - self.get_entity_cookie_security_configurations_endpoint = _Endpoint( + self.create_entity_data_sources_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiCookieSecurityConfigurationOutDocument,), + 'response_type': (JsonApiDataSourceOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/admin/cookieSecurityConfigurations/{id}', - 'operation_id': 'get_entity_cookie_security_configurations', - 'http_method': 'GET', + 'endpoint_path': '/api/v1/entities/dataSources', + 'operation_id': 'create_entity_data_sources', + 'http_method': 'POST', 'servers': None, }, params_map={ 'all': [ - 'id', - 'filter', + 'json_api_data_source_in_document', + 'meta_include', ], 'required': [ - 'id', + 'json_api_data_source_in_document', ], 'nullable': [ ], 'enum': [ + 'meta_include', ], 'validation': [ - 'id', + 'meta_include', ] }, root_map={ 'validations': { - ('id',): { + ('meta_include',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, }, }, 'allowed_values': { + ('meta_include',): { + + "PERMISSIONS": "permissions", + "ALL": "all", + "ALL": "ALL" + }, }, 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), + 'json_api_data_source_in_document': + (JsonApiDataSourceInDocument,), + 'meta_include': + ([str],), }, 'attribute_map': { - 'id': 'id', - 'filter': 'filter', + 'meta_include': 'metaInclude', }, 'location_map': { - 'id': 'path', - 'filter': 'query', + 'json_api_data_source_in_document': 'body', + 'meta_include': 'query', }, 'collection_format_map': { + 'meta_include': 'csv', } }, headers_map={ @@ -99,25 +101,26 @@ def __init__(self, api_client=None): 'application/json', 'application/vnd.gooddata.api+json' ], - 'content_type': [], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] }, api_client=api_client ) - self.get_entity_organizations_endpoint = _Endpoint( + self.delete_entity_data_sources_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiOrganizationOutDocument,), + 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/admin/organizations/{id}', - 'operation_id': 'get_entity_organizations', - 'http_method': 'GET', + 'endpoint_path': '/api/v1/entities/dataSources/{id}', + 'operation_id': 'delete_entity_data_sources', + 'http_method': 'DELETE', 'servers': None, }, params_map={ 'all': [ 'id', 'filter', - 'include', - 'meta_include', ], 'required': [ 'id', @@ -125,12 +128,9 @@ def __init__(self, api_client=None): 'nullable': [ ], 'enum': [ - 'include', - 'meta_include', ], 'validation': [ 'id', - 'meta_include', ] }, root_map={ @@ -141,120 +141,103 @@ def __init__(self, api_client=None): 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 }, }, - ('meta_include',): { - - }, }, 'allowed_values': { - ('include',): { - - "USERS": "users", - "USERGROUPS": "userGroups", - "IDENTITYPROVIDERS": "identityProviders", - "BOOTSTRAPUSER": "bootstrapUser", - "BOOTSTRAPUSERGROUP": "bootstrapUserGroup", - "IDENTITYPROVIDER": "identityProvider", - "ALL": "ALL" - }, - ('meta_include',): { - - "PERMISSIONS": "permissions", - "ALL": "all", - "ALL": "ALL" - }, }, 'openapi_types': { 'id': (str,), 'filter': (str,), - 'include': - ([str],), - 'meta_include': - ([str],), }, 'attribute_map': { 'id': 'id', 'filter': 'filter', - 'include': 'include', - 'meta_include': 'metaInclude', }, 'location_map': { 'id': 'path', 'filter': 'query', - 'include': 'query', - 'meta_include': 'query', }, 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', } }, headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], + 'accept': [], 'content_type': [], }, api_client=api_client ) - self.patch_entity_cookie_security_configurations_endpoint = _Endpoint( + self.get_all_entities_data_sources_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiCookieSecurityConfigurationOutDocument,), + 'response_type': (JsonApiDataSourceOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/admin/cookieSecurityConfigurations/{id}', - 'operation_id': 'patch_entity_cookie_security_configurations', - 'http_method': 'PATCH', + 'endpoint_path': '/api/v1/entities/dataSources', + 'operation_id': 'get_all_entities_data_sources', + 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ - 'id', - 'json_api_cookie_security_configuration_patch_document', 'filter', + 'page', + 'size', + 'sort', + 'meta_include', ], - 'required': [ - 'id', - 'json_api_cookie_security_configuration_patch_document', - ], + 'required': [], 'nullable': [ ], 'enum': [ + 'meta_include', ], 'validation': [ - 'id', + 'meta_include', ] }, root_map={ 'validations': { - ('id',): { + ('meta_include',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, }, }, 'allowed_values': { + ('meta_include',): { + + "PERMISSIONS": "permissions", + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, }, 'openapi_types': { - 'id': - (str,), - 'json_api_cookie_security_configuration_patch_document': - (JsonApiCookieSecurityConfigurationPatchDocument,), 'filter': (str,), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'meta_include': + ([str],), }, 'attribute_map': { - 'id': 'id', 'filter': 'filter', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'meta_include': 'metaInclude', }, 'location_map': { - 'id': 'path', - 'json_api_cookie_security_configuration_patch_document': 'body', 'filter': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'meta_include': 'query', }, 'collection_format_map': { + 'sort': 'multi', + 'meta_include': 'csv', } }, headers_map={ @@ -262,40 +245,36 @@ def __init__(self, api_client=None): 'application/json', 'application/vnd.gooddata.api+json' ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] + 'content_type': [], }, api_client=api_client ) - self.patch_entity_organizations_endpoint = _Endpoint( + self.get_entity_data_sources_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiOrganizationOutDocument,), + 'response_type': (JsonApiDataSourceOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/admin/organizations/{id}', - 'operation_id': 'patch_entity_organizations', - 'http_method': 'PATCH', + 'endpoint_path': '/api/v1/entities/dataSources/{id}', + 'operation_id': 'get_entity_data_sources', + 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ 'id', - 'json_api_organization_patch_document', 'filter', - 'include', + 'meta_include', ], 'required': [ 'id', - 'json_api_organization_patch_document', ], 'nullable': [ ], 'enum': [ - 'include', + 'meta_include', ], 'validation': [ 'id', + 'meta_include', ] }, root_map={ @@ -306,42 +285,38 @@ def __init__(self, api_client=None): 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 }, }, + ('meta_include',): { + + }, }, 'allowed_values': { - ('include',): { + ('meta_include',): { - "USERS": "users", - "USERGROUPS": "userGroups", - "IDENTITYPROVIDERS": "identityProviders", - "BOOTSTRAPUSER": "bootstrapUser", - "BOOTSTRAPUSERGROUP": "bootstrapUserGroup", - "IDENTITYPROVIDER": "identityProvider", + "PERMISSIONS": "permissions", + "ALL": "all", "ALL": "ALL" }, }, 'openapi_types': { 'id': (str,), - 'json_api_organization_patch_document': - (JsonApiOrganizationPatchDocument,), 'filter': (str,), - 'include': + 'meta_include': ([str],), }, 'attribute_map': { 'id': 'id', 'filter': 'filter', - 'include': 'include', + 'meta_include': 'metaInclude', }, 'location_map': { 'id': 'path', - 'json_api_organization_patch_document': 'body', 'filter': 'query', - 'include': 'query', + 'meta_include': 'query', }, 'collection_format_map': { - 'include': 'csv', + 'meta_include': 'csv', } }, headers_map={ @@ -349,31 +324,28 @@ def __init__(self, api_client=None): 'application/json', 'application/vnd.gooddata.api+json' ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] + 'content_type': [], }, api_client=api_client ) - self.update_entity_cookie_security_configurations_endpoint = _Endpoint( + self.patch_entity_data_sources_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiCookieSecurityConfigurationOutDocument,), + 'response_type': (JsonApiDataSourceOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/admin/cookieSecurityConfigurations/{id}', - 'operation_id': 'update_entity_cookie_security_configurations', - 'http_method': 'PUT', + 'endpoint_path': '/api/v1/entities/dataSources/{id}', + 'operation_id': 'patch_entity_data_sources', + 'http_method': 'PATCH', 'servers': None, }, params_map={ 'all': [ 'id', - 'json_api_cookie_security_configuration_in_document', + 'json_api_data_source_patch_document', 'filter', ], 'required': [ 'id', - 'json_api_cookie_security_configuration_in_document', + 'json_api_data_source_patch_document', ], 'nullable': [ ], @@ -397,8 +369,8 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), - 'json_api_cookie_security_configuration_in_document': - (JsonApiCookieSecurityConfigurationInDocument,), + 'json_api_data_source_patch_document': + (JsonApiDataSourcePatchDocument,), 'filter': (str,), }, @@ -408,7 +380,7 @@ def __init__(self, api_client=None): }, 'location_map': { 'id': 'path', - 'json_api_cookie_security_configuration_in_document': 'body', + 'json_api_data_source_patch_document': 'body', 'filter': 'query', }, 'collection_format_map': { @@ -426,30 +398,28 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.update_entity_organizations_endpoint = _Endpoint( + self.update_entity_data_sources_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiOrganizationOutDocument,), + 'response_type': (JsonApiDataSourceOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/admin/organizations/{id}', - 'operation_id': 'update_entity_organizations', + 'endpoint_path': '/api/v1/entities/dataSources/{id}', + 'operation_id': 'update_entity_data_sources', 'http_method': 'PUT', 'servers': None, }, params_map={ 'all': [ 'id', - 'json_api_organization_in_document', + 'json_api_data_source_in_document', 'filter', - 'include', ], 'required': [ 'id', - 'json_api_organization_in_document', + 'json_api_data_source_in_document', ], 'nullable': [ ], 'enum': [ - 'include', ], 'validation': [ 'id', @@ -465,40 +435,25 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { - ('include',): { - - "USERS": "users", - "USERGROUPS": "userGroups", - "IDENTITYPROVIDERS": "identityProviders", - "BOOTSTRAPUSER": "bootstrapUser", - "BOOTSTRAPUSERGROUP": "bootstrapUserGroup", - "IDENTITYPROVIDER": "identityProvider", - "ALL": "ALL" - }, }, 'openapi_types': { 'id': (str,), - 'json_api_organization_in_document': - (JsonApiOrganizationInDocument,), + 'json_api_data_source_in_document': + (JsonApiDataSourceInDocument,), 'filter': (str,), - 'include': - ([str],), }, 'attribute_map': { 'id': 'id', 'filter': 'filter', - 'include': 'include', }, 'location_map': { 'id': 'path', - 'json_api_organization_in_document': 'body', + 'json_api_data_source_in_document': 'body', 'filter': 'query', - 'include': 'query', }, 'collection_format_map': { - 'include': 'csv', } }, headers_map={ @@ -514,24 +469,25 @@ def __init__(self, api_client=None): api_client=api_client ) - def get_entity_cookie_security_configurations( + def create_entity_data_sources( self, - id, + json_api_data_source_in_document, **kwargs ): - """Get CookieSecurityConfiguration # noqa: E501 + """Post Data Sources # noqa: E501 + Data Source - represents data source for the workspace # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_cookie_security_configurations(id, async_req=True) + >>> thread = api.create_entity_data_sources(json_api_data_source_in_document, async_req=True) >>> result = thread.get() Args: - id (str): + json_api_data_source_in_document (JsonApiDataSourceInDocument): Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -564,7 +520,7 @@ def get_entity_cookie_security_configurations( async_req (bool): execute request asynchronously Returns: - JsonApiCookieSecurityConfigurationOutDocument + JsonApiDataSourceOutDocument If the method is called asynchronously, returns the request thread. """ @@ -593,21 +549,22 @@ def get_entity_cookie_security_configurations( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_cookie_security_configurations_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_data_source_in_document'] = \ + json_api_data_source_in_document + return self.create_entity_data_sources_endpoint.call_with_http_info(**kwargs) - def get_entity_organizations( + def delete_entity_data_sources( self, id, **kwargs ): - """Get Organizations # noqa: E501 + """Delete Data Source entity # noqa: E501 + Data Source - represents data source for the workspace # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_organizations(id, async_req=True) + >>> thread = api.delete_entity_data_sources(id, async_req=True) >>> result = thread.get() Args: @@ -615,8 +572,6 @@ def get_entity_organizations( Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -649,7 +604,7 @@ def get_entity_organizations( async_req (bool): execute request asynchronously Returns: - JsonApiOrganizationOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -680,28 +635,28 @@ def get_entity_organizations( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.get_entity_organizations_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_data_sources_endpoint.call_with_http_info(**kwargs) - def patch_entity_cookie_security_configurations( + def get_all_entities_data_sources( self, - id, - json_api_cookie_security_configuration_patch_document, **kwargs ): - """Patch CookieSecurityConfiguration # noqa: E501 + """Get Data Source entities # noqa: E501 + Data Source - represents data source for the workspace # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.patch_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_patch_document, async_req=True) + >>> thread = api.get_all_entities_data_sources(async_req=True) >>> result = thread.get() - Args: - id (str): - json_api_cookie_security_configuration_patch_document (JsonApiCookieSecurityConfigurationPatchDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -734,7 +689,7 @@ def patch_entity_cookie_security_configurations( async_req (bool): execute request asynchronously Returns: - JsonApiCookieSecurityConfigurationOutDocument + JsonApiDataSourceOutList If the method is called asynchronously, returns the request thread. """ @@ -763,33 +718,28 @@ def patch_entity_cookie_security_configurations( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_cookie_security_configuration_patch_document'] = \ - json_api_cookie_security_configuration_patch_document - return self.patch_entity_cookie_security_configurations_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_data_sources_endpoint.call_with_http_info(**kwargs) - def patch_entity_organizations( + def get_entity_data_sources( self, id, - json_api_organization_patch_document, **kwargs ): - """Patch Organization # noqa: E501 + """Get Data Source entity # noqa: E501 + Data Source - represents data source for the workspace # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.patch_entity_organizations(id, json_api_organization_patch_document, async_req=True) + >>> thread = api.get_entity_data_sources(id, async_req=True) >>> result = thread.get() Args: id (str): - json_api_organization_patch_document (JsonApiOrganizationPatchDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -822,7 +772,7 @@ def patch_entity_organizations( async_req (bool): execute request asynchronously Returns: - JsonApiOrganizationOutDocument + JsonApiDataSourceOutDocument If the method is called asynchronously, returns the request thread. """ @@ -853,27 +803,26 @@ def patch_entity_organizations( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - kwargs['json_api_organization_patch_document'] = \ - json_api_organization_patch_document - return self.patch_entity_organizations_endpoint.call_with_http_info(**kwargs) + return self.get_entity_data_sources_endpoint.call_with_http_info(**kwargs) - def update_entity_cookie_security_configurations( + def patch_entity_data_sources( self, id, - json_api_cookie_security_configuration_in_document, + json_api_data_source_patch_document, **kwargs ): - """Put CookieSecurityConfiguration # noqa: E501 + """Patch Data Source entity # noqa: E501 + Data Source - represents data source for the workspace # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_in_document, async_req=True) + >>> thread = api.patch_entity_data_sources(id, json_api_data_source_patch_document, async_req=True) >>> result = thread.get() Args: id (str): - json_api_cookie_security_configuration_in_document (JsonApiCookieSecurityConfigurationInDocument): + json_api_data_source_patch_document (JsonApiDataSourcePatchDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -909,7 +858,7 @@ def update_entity_cookie_security_configurations( async_req (bool): execute request asynchronously Returns: - JsonApiCookieSecurityConfigurationOutDocument + JsonApiDataSourceOutDocument If the method is called asynchronously, returns the request thread. """ @@ -940,31 +889,31 @@ def update_entity_cookie_security_configurations( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - kwargs['json_api_cookie_security_configuration_in_document'] = \ - json_api_cookie_security_configuration_in_document - return self.update_entity_cookie_security_configurations_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_data_source_patch_document'] = \ + json_api_data_source_patch_document + return self.patch_entity_data_sources_endpoint.call_with_http_info(**kwargs) - def update_entity_organizations( + def update_entity_data_sources( self, id, - json_api_organization_in_document, + json_api_data_source_in_document, **kwargs ): - """Put Organization # noqa: E501 + """Put Data Source entity # noqa: E501 + Data Source - represents data source for the workspace # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_organizations(id, json_api_organization_in_document, async_req=True) + >>> thread = api.update_entity_data_sources(id, json_api_data_source_in_document, async_req=True) >>> result = thread.get() Args: id (str): - json_api_organization_in_document (JsonApiOrganizationInDocument): + json_api_data_source_in_document (JsonApiDataSourceInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -997,7 +946,7 @@ def update_entity_organizations( async_req (bool): execute request asynchronously Returns: - JsonApiOrganizationOutDocument + JsonApiDataSourceOutDocument If the method is called asynchronously, returns the request thread. """ @@ -1028,7 +977,7 @@ def update_entity_organizations( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - kwargs['json_api_organization_in_document'] = \ - json_api_organization_in_document - return self.update_entity_organizations_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_data_source_in_document'] = \ + json_api_data_source_in_document + return self.update_entity_data_sources_endpoint.call_with_http_info(**kwargs) diff --git a/gooddata-api-client/gooddata_api_client/api/dataset_controller_api.py b/gooddata-api-client/gooddata_api_client/api/dataset_controller_api.py new file mode 100644 index 000000000..58adf7926 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/dataset_controller_api.py @@ -0,0 +1,785 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint +from gooddata_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from gooddata_api_client.model.entity_search_body import EntitySearchBody +from gooddata_api_client.model.json_api_dataset_out_document import JsonApiDatasetOutDocument +from gooddata_api_client.model.json_api_dataset_out_list import JsonApiDatasetOutList +from gooddata_api_client.model.json_api_dataset_patch_document import JsonApiDatasetPatchDocument + + +class DatasetControllerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_all_entities_datasets_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiDatasetOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/datasets', + 'operation_id': 'get_all_entities_datasets', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'origin', + 'filter', + 'include', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('include',): { + + "ATTRIBUTES": "attributes", + "FACTS": "facts", + "AGGREGATEDFACTS": "aggregatedFacts", + "DATASETS": "datasets", + "WORKSPACEDATAFILTERS": "workspaceDataFilters", + "REFERENCES": "references", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'origin': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'filter': 'filter', + 'include': 'include', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'origin': 'query', + 'filter': 'query', + 'include': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_datasets_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiDatasetOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/datasets/{objectId}', + 'operation_id': 'get_entity_datasets', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + 'include', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "ATTRIBUTES": "attributes", + "FACTS": "facts", + "AGGREGATEDFACTS": "aggregatedFacts", + "DATASETS": "datasets", + "WORKSPACEDATAFILTERS": "workspaceDataFilters", + "REFERENCES": "references", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + 'include': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.patch_entity_datasets_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiDatasetOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/datasets/{objectId}', + 'operation_id': 'patch_entity_datasets', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_dataset_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_dataset_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "ATTRIBUTES": "attributes", + "FACTS": "facts", + "AGGREGATEDFACTS": "aggregatedFacts", + "DATASETS": "datasets", + "WORKSPACEDATAFILTERS": "workspaceDataFilters", + "REFERENCES": "references", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_dataset_patch_document': + (JsonApiDatasetPatchDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_dataset_patch_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.search_entities_datasets_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiDatasetOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/datasets/search', + 'operation_id': 'search_entities_datasets', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'entity_search_body', + 'origin', + 'x_gdc_validate_relations', + ], + 'required': [ + 'workspace_id', + 'entity_search_body', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'entity_search_body': + (EntitySearchBody,), + 'origin': + (str,), + 'x_gdc_validate_relations': + (bool,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + }, + 'location_map': { + 'workspace_id': 'path', + 'entity_search_body': 'body', + 'origin': 'query', + 'x_gdc_validate_relations': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def get_all_entities_datasets( + self, + workspace_id, + **kwargs + ): + """Get all Datasets # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_datasets(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiDatasetOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_datasets_endpoint.call_with_http_info(**kwargs) + + def get_entity_datasets( + self, + workspace_id, + object_id, + **kwargs + ): + """Get a Dataset # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_datasets(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiDatasetOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_datasets_endpoint.call_with_http_info(**kwargs) + + def patch_entity_datasets( + self, + workspace_id, + object_id, + json_api_dataset_patch_document, + **kwargs + ): + """Patch a Dataset (beta) # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_entity_datasets(workspace_id, object_id, json_api_dataset_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_dataset_patch_document (JsonApiDatasetPatchDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiDatasetOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_dataset_patch_document'] = \ + json_api_dataset_patch_document + return self.patch_entity_datasets_endpoint.call_with_http_info(**kwargs) + + def search_entities_datasets( + self, + workspace_id, + entity_search_body, + **kwargs + ): + """The search endpoint (beta) # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_entities_datasets(workspace_id, entity_search_body, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiDatasetOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['entity_search_body'] = \ + entity_search_body + return self.search_entities_datasets_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/datasets_api.py b/gooddata-api-client/gooddata_api_client/api/datasets_api.py index d74bf0c06..53af85ab9 100644 --- a/gooddata-api-client/gooddata_api_client/api/datasets_api.py +++ b/gooddata-api-client/gooddata_api_client/api/datasets_api.py @@ -701,7 +701,7 @@ def search_entities_datasets( entity_search_body, **kwargs ): - """Search request for Dataset # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/entities_api.py b/gooddata-api-client/gooddata_api_client/api/entities_api.py index 0b67eeb16..407edb3be 100644 --- a/gooddata-api-client/gooddata_api_client/api/entities_api.py +++ b/gooddata-api-client/gooddata_api_client/api/entities_api.py @@ -20509,7 +20509,7 @@ def create_entity_custom_geo_collections( json_api_custom_geo_collection_in_document, **kwargs ): - """create_entity_custom_geo_collections # noqa: E501 + """Post Custom Geo Collections # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -23328,7 +23328,7 @@ def delete_entity_custom_geo_collections( id, **kwargs ): - """delete_entity_custom_geo_collections # noqa: E501 + """Delete Custom Geo Collection # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -26416,7 +26416,7 @@ def get_all_entities_custom_geo_collections( self, **kwargs ): - """get_all_entities_custom_geo_collections # noqa: E501 + """Get all Custom Geo Collections # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -30289,7 +30289,7 @@ def get_entity_custom_geo_collections( id, **kwargs ): - """get_entity_custom_geo_collections # noqa: E501 + """Get Custom Geo Collection # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -34034,7 +34034,7 @@ def patch_entity_custom_geo_collections( json_api_custom_geo_collection_patch_document, **kwargs ): - """patch_entity_custom_geo_collections # noqa: E501 + """Patch Custom Geo Collection # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -36728,7 +36728,7 @@ def search_entities_analytical_dashboards( entity_search_body, **kwargs ): - """Search request for AnalyticalDashboard # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -36816,7 +36816,7 @@ def search_entities_attribute_hierarchies( entity_search_body, **kwargs ): - """Search request for AttributeHierarchy # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -36904,7 +36904,7 @@ def search_entities_attributes( entity_search_body, **kwargs ): - """Search request for Attribute # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -37080,7 +37080,7 @@ def search_entities_automations( entity_search_body, **kwargs ): - """Search request for Automation # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -37168,7 +37168,7 @@ def search_entities_custom_application_settings( entity_search_body, **kwargs ): - """Search request for CustomApplicationSetting # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -37256,7 +37256,7 @@ def search_entities_dashboard_plugins( entity_search_body, **kwargs ): - """Search request for DashboardPlugin # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -37344,7 +37344,7 @@ def search_entities_datasets( entity_search_body, **kwargs ): - """Search request for Dataset # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -37432,7 +37432,7 @@ def search_entities_export_definitions( entity_search_body, **kwargs ): - """Search request for ExportDefinition # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -37520,7 +37520,7 @@ def search_entities_facts( entity_search_body, **kwargs ): - """Search request for Fact # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -37608,7 +37608,7 @@ def search_entities_filter_contexts( entity_search_body, **kwargs ): - """Search request for FilterContext # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -37696,7 +37696,7 @@ def search_entities_filter_views( entity_search_body, **kwargs ): - """Search request for FilterView # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -37784,7 +37784,7 @@ def search_entities_knowledge_recommendations( entity_search_body, **kwargs ): - """search_entities_knowledge_recommendations # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -37872,7 +37872,7 @@ def search_entities_labels( entity_search_body, **kwargs ): - """Search request for Label # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -38048,7 +38048,7 @@ def search_entities_metrics( entity_search_body, **kwargs ): - """Search request for Metric # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -38136,7 +38136,7 @@ def search_entities_user_data_filters( entity_search_body, **kwargs ): - """Search request for UserDataFilter # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -38224,7 +38224,7 @@ def search_entities_visualization_objects( entity_search_body, **kwargs ): - """Search request for VisualizationObject # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -38312,7 +38312,7 @@ def search_entities_workspace_data_filter_settings( entity_search_body, **kwargs ): - """Search request for WorkspaceDataFilterSetting # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -38400,7 +38400,7 @@ def search_entities_workspace_data_filters( entity_search_body, **kwargs ): - """Search request for WorkspaceDataFilter # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -38488,7 +38488,7 @@ def search_entities_workspace_settings( entity_search_body, **kwargs ): - """search_entities_workspace_settings # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -39205,7 +39205,7 @@ def update_entity_custom_geo_collections( json_api_custom_geo_collection_in_document, **kwargs ): - """update_entity_custom_geo_collections # noqa: E501 + """Put Custom Geo Collection # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/export_definition_controller_api.py b/gooddata-api-client/gooddata_api_client/api/export_definition_controller_api.py new file mode 100644 index 000000000..5c98c9104 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/export_definition_controller_api.py @@ -0,0 +1,1305 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint +from gooddata_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from gooddata_api_client.model.entity_search_body import EntitySearchBody +from gooddata_api_client.model.json_api_export_definition_in_document import JsonApiExportDefinitionInDocument +from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument +from gooddata_api_client.model.json_api_export_definition_out_list import JsonApiExportDefinitionOutList +from gooddata_api_client.model.json_api_export_definition_patch_document import JsonApiExportDefinitionPatchDocument +from gooddata_api_client.model.json_api_export_definition_post_optional_id_document import JsonApiExportDefinitionPostOptionalIdDocument + + +class ExportDefinitionControllerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_entity_export_definitions_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiExportDefinitionOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions', + 'operation_id': 'create_entity_export_definitions', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_export_definition_post_optional_id_document', + 'include', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_export_definition_post_optional_id_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "VISUALIZATIONOBJECTS": "visualizationObjects", + "ANALYTICALDASHBOARDS": "analyticalDashboards", + "AUTOMATIONS": "automations", + "USERIDENTIFIERS": "userIdentifiers", + "VISUALIZATIONOBJECT": "visualizationObject", + "ANALYTICALDASHBOARD": "analyticalDashboard", + "AUTOMATION": "automation", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'json_api_export_definition_post_optional_id_document': + (JsonApiExportDefinitionPostOptionalIdDocument,), + 'include': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'include': 'include', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_export_definition_post_optional_id_document': 'body', + 'include': 'query', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.delete_entity_export_definitions_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', + 'operation_id': 'delete_entity_export_definitions', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_entities_export_definitions_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiExportDefinitionOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions', + 'operation_id': 'get_all_entities_export_definitions', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'origin', + 'filter', + 'include', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('include',): { + + "VISUALIZATIONOBJECTS": "visualizationObjects", + "ANALYTICALDASHBOARDS": "analyticalDashboards", + "AUTOMATIONS": "automations", + "USERIDENTIFIERS": "userIdentifiers", + "VISUALIZATIONOBJECT": "visualizationObject", + "ANALYTICALDASHBOARD": "analyticalDashboard", + "AUTOMATION": "automation", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'origin': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'filter': 'filter', + 'include': 'include', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'origin': 'query', + 'filter': 'query', + 'include': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_export_definitions_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiExportDefinitionOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', + 'operation_id': 'get_entity_export_definitions', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + 'include', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "VISUALIZATIONOBJECTS": "visualizationObjects", + "ANALYTICALDASHBOARDS": "analyticalDashboards", + "AUTOMATIONS": "automations", + "USERIDENTIFIERS": "userIdentifiers", + "VISUALIZATIONOBJECT": "visualizationObject", + "ANALYTICALDASHBOARD": "analyticalDashboard", + "AUTOMATION": "automation", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + 'include': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.patch_entity_export_definitions_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiExportDefinitionOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', + 'operation_id': 'patch_entity_export_definitions', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_export_definition_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_export_definition_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "VISUALIZATIONOBJECTS": "visualizationObjects", + "ANALYTICALDASHBOARDS": "analyticalDashboards", + "AUTOMATIONS": "automations", + "USERIDENTIFIERS": "userIdentifiers", + "VISUALIZATIONOBJECT": "visualizationObject", + "ANALYTICALDASHBOARD": "analyticalDashboard", + "AUTOMATION": "automation", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_export_definition_patch_document': + (JsonApiExportDefinitionPatchDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_export_definition_patch_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.search_entities_export_definitions_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiExportDefinitionOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/search', + 'operation_id': 'search_entities_export_definitions', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'entity_search_body', + 'origin', + 'x_gdc_validate_relations', + ], + 'required': [ + 'workspace_id', + 'entity_search_body', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'entity_search_body': + (EntitySearchBody,), + 'origin': + (str,), + 'x_gdc_validate_relations': + (bool,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + }, + 'location_map': { + 'workspace_id': 'path', + 'entity_search_body': 'body', + 'origin': 'query', + 'x_gdc_validate_relations': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_entity_export_definitions_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiExportDefinitionOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', + 'operation_id': 'update_entity_export_definitions', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_export_definition_in_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_export_definition_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "VISUALIZATIONOBJECTS": "visualizationObjects", + "ANALYTICALDASHBOARDS": "analyticalDashboards", + "AUTOMATIONS": "automations", + "USERIDENTIFIERS": "userIdentifiers", + "VISUALIZATIONOBJECT": "visualizationObject", + "ANALYTICALDASHBOARD": "analyticalDashboard", + "AUTOMATION": "automation", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_export_definition_in_document': + (JsonApiExportDefinitionInDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_export_definition_in_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + + def create_entity_export_definitions( + self, + workspace_id, + json_api_export_definition_post_optional_id_document, + **kwargs + ): + """Post Export Definitions # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_export_definitions(workspace_id, json_api_export_definition_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_export_definition_post_optional_id_document (JsonApiExportDefinitionPostOptionalIdDocument): + + Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiExportDefinitionOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['json_api_export_definition_post_optional_id_document'] = \ + json_api_export_definition_post_optional_id_document + return self.create_entity_export_definitions_endpoint.call_with_http_info(**kwargs) + + def delete_entity_export_definitions( + self, + workspace_id, + object_id, + **kwargs + ): + """Delete an Export Definition # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_entity_export_definitions(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_export_definitions_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_export_definitions( + self, + workspace_id, + **kwargs + ): + """Get all Export Definitions # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_export_definitions(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiExportDefinitionOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_export_definitions_endpoint.call_with_http_info(**kwargs) + + def get_entity_export_definitions( + self, + workspace_id, + object_id, + **kwargs + ): + """Get an Export Definition # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_export_definitions(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiExportDefinitionOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_export_definitions_endpoint.call_with_http_info(**kwargs) + + def patch_entity_export_definitions( + self, + workspace_id, + object_id, + json_api_export_definition_patch_document, + **kwargs + ): + """Patch an Export Definition # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_entity_export_definitions(workspace_id, object_id, json_api_export_definition_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_export_definition_patch_document (JsonApiExportDefinitionPatchDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiExportDefinitionOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_export_definition_patch_document'] = \ + json_api_export_definition_patch_document + return self.patch_entity_export_definitions_endpoint.call_with_http_info(**kwargs) + + def search_entities_export_definitions( + self, + workspace_id, + entity_search_body, + **kwargs + ): + """The search endpoint (beta) # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_entities_export_definitions(workspace_id, entity_search_body, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiExportDefinitionOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['entity_search_body'] = \ + entity_search_body + return self.search_entities_export_definitions_endpoint.call_with_http_info(**kwargs) + + def update_entity_export_definitions( + self, + workspace_id, + object_id, + json_api_export_definition_in_document, + **kwargs + ): + """Put an Export Definition # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_entity_export_definitions(workspace_id, object_id, json_api_export_definition_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_export_definition_in_document (JsonApiExportDefinitionInDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiExportDefinitionOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_export_definition_in_document'] = \ + json_api_export_definition_in_document + return self.update_entity_export_definitions_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/export_definitions_api.py b/gooddata-api-client/gooddata_api_client/api/export_definitions_api.py index 2041e7098..b40dfa5ca 100644 --- a/gooddata-api-client/gooddata_api_client/api/export_definitions_api.py +++ b/gooddata-api-client/gooddata_api_client/api/export_definitions_api.py @@ -1129,7 +1129,7 @@ def search_entities_export_definitions( entity_search_body, **kwargs ): - """Search request for ExportDefinition # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/fact_controller_api.py b/gooddata-api-client/gooddata_api_client/api/fact_controller_api.py new file mode 100644 index 000000000..0e14c5536 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/fact_controller_api.py @@ -0,0 +1,773 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint +from gooddata_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from gooddata_api_client.model.entity_search_body import EntitySearchBody +from gooddata_api_client.model.json_api_fact_out_document import JsonApiFactOutDocument +from gooddata_api_client.model.json_api_fact_out_list import JsonApiFactOutList +from gooddata_api_client.model.json_api_fact_patch_document import JsonApiFactPatchDocument + + +class FactControllerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_all_entities_facts_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiFactOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/facts', + 'operation_id': 'get_all_entities_facts', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'origin', + 'filter', + 'include', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('include',): { + + "DATASETS": "datasets", + "DATASET": "dataset", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'origin': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'filter': 'filter', + 'include': 'include', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'origin': 'query', + 'filter': 'query', + 'include': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_facts_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiFactOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/facts/{objectId}', + 'operation_id': 'get_entity_facts', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + 'include', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "DATASETS": "datasets", + "DATASET": "dataset", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + 'include': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.patch_entity_facts_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiFactOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/facts/{objectId}', + 'operation_id': 'patch_entity_facts', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_fact_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_fact_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "DATASETS": "datasets", + "DATASET": "dataset", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_fact_patch_document': + (JsonApiFactPatchDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_fact_patch_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.search_entities_facts_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiFactOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/facts/search', + 'operation_id': 'search_entities_facts', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'entity_search_body', + 'origin', + 'x_gdc_validate_relations', + ], + 'required': [ + 'workspace_id', + 'entity_search_body', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'entity_search_body': + (EntitySearchBody,), + 'origin': + (str,), + 'x_gdc_validate_relations': + (bool,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + }, + 'location_map': { + 'workspace_id': 'path', + 'entity_search_body': 'body', + 'origin': 'query', + 'x_gdc_validate_relations': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def get_all_entities_facts( + self, + workspace_id, + **kwargs + ): + """Get all Facts # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_facts(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiFactOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_facts_endpoint.call_with_http_info(**kwargs) + + def get_entity_facts( + self, + workspace_id, + object_id, + **kwargs + ): + """Get a Fact # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_facts(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiFactOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_facts_endpoint.call_with_http_info(**kwargs) + + def patch_entity_facts( + self, + workspace_id, + object_id, + json_api_fact_patch_document, + **kwargs + ): + """Patch a Fact (beta) # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_entity_facts(workspace_id, object_id, json_api_fact_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_fact_patch_document (JsonApiFactPatchDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiFactOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_fact_patch_document'] = \ + json_api_fact_patch_document + return self.patch_entity_facts_endpoint.call_with_http_info(**kwargs) + + def search_entities_facts( + self, + workspace_id, + entity_search_body, + **kwargs + ): + """The search endpoint (beta) # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_entities_facts(workspace_id, entity_search_body, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiFactOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['entity_search_body'] = \ + entity_search_body + return self.search_entities_facts_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/facts_api.py b/gooddata-api-client/gooddata_api_client/api/facts_api.py index 7dc6b50c9..d2af83606 100644 --- a/gooddata-api-client/gooddata_api_client/api/facts_api.py +++ b/gooddata-api-client/gooddata_api_client/api/facts_api.py @@ -1252,7 +1252,7 @@ def search_entities_facts( entity_search_body, **kwargs ): - """Search request for Fact # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/filter_context_api.py b/gooddata-api-client/gooddata_api_client/api/filter_context_api.py index 741a4e93f..7cd84133e 100644 --- a/gooddata-api-client/gooddata_api_client/api/filter_context_api.py +++ b/gooddata-api-client/gooddata_api_client/api/filter_context_api.py @@ -1099,7 +1099,7 @@ def search_entities_filter_contexts( entity_search_body, **kwargs ): - """Search request for FilterContext # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/filter_context_controller_api.py b/gooddata-api-client/gooddata_api_client/api/filter_context_controller_api.py new file mode 100644 index 000000000..55f32dbcb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/filter_context_controller_api.py @@ -0,0 +1,1275 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint +from gooddata_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from gooddata_api_client.model.entity_search_body import EntitySearchBody +from gooddata_api_client.model.json_api_filter_context_in_document import JsonApiFilterContextInDocument +from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.model.json_api_filter_context_out_list import JsonApiFilterContextOutList +from gooddata_api_client.model.json_api_filter_context_patch_document import JsonApiFilterContextPatchDocument +from gooddata_api_client.model.json_api_filter_context_post_optional_id_document import JsonApiFilterContextPostOptionalIdDocument + + +class FilterContextControllerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_entity_filter_contexts_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiFilterContextOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts', + 'operation_id': 'create_entity_filter_contexts', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_filter_context_post_optional_id_document', + 'include', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_filter_context_post_optional_id_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "ATTRIBUTES": "attributes", + "DATASETS": "datasets", + "LABELS": "labels", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'json_api_filter_context_post_optional_id_document': + (JsonApiFilterContextPostOptionalIdDocument,), + 'include': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'include': 'include', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_filter_context_post_optional_id_document': 'body', + 'include': 'query', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.delete_entity_filter_contexts_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', + 'operation_id': 'delete_entity_filter_contexts', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_entities_filter_contexts_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiFilterContextOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts', + 'operation_id': 'get_all_entities_filter_contexts', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'origin', + 'filter', + 'include', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('include',): { + + "ATTRIBUTES": "attributes", + "DATASETS": "datasets", + "LABELS": "labels", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'origin': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'filter': 'filter', + 'include': 'include', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'origin': 'query', + 'filter': 'query', + 'include': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_filter_contexts_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiFilterContextOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', + 'operation_id': 'get_entity_filter_contexts', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + 'include', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "ATTRIBUTES": "attributes", + "DATASETS": "datasets", + "LABELS": "labels", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + 'include': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.patch_entity_filter_contexts_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiFilterContextOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', + 'operation_id': 'patch_entity_filter_contexts', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_filter_context_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_filter_context_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "ATTRIBUTES": "attributes", + "DATASETS": "datasets", + "LABELS": "labels", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_filter_context_patch_document': + (JsonApiFilterContextPatchDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_filter_context_patch_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.search_entities_filter_contexts_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiFilterContextOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts/search', + 'operation_id': 'search_entities_filter_contexts', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'entity_search_body', + 'origin', + 'x_gdc_validate_relations', + ], + 'required': [ + 'workspace_id', + 'entity_search_body', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'entity_search_body': + (EntitySearchBody,), + 'origin': + (str,), + 'x_gdc_validate_relations': + (bool,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + }, + 'location_map': { + 'workspace_id': 'path', + 'entity_search_body': 'body', + 'origin': 'query', + 'x_gdc_validate_relations': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_entity_filter_contexts_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiFilterContextOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', + 'operation_id': 'update_entity_filter_contexts', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_filter_context_in_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_filter_context_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "ATTRIBUTES": "attributes", + "DATASETS": "datasets", + "LABELS": "labels", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_filter_context_in_document': + (JsonApiFilterContextInDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_filter_context_in_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + + def create_entity_filter_contexts( + self, + workspace_id, + json_api_filter_context_post_optional_id_document, + **kwargs + ): + """Post Filter Context # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_filter_contexts(workspace_id, json_api_filter_context_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_filter_context_post_optional_id_document (JsonApiFilterContextPostOptionalIdDocument): + + Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiFilterContextOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['json_api_filter_context_post_optional_id_document'] = \ + json_api_filter_context_post_optional_id_document + return self.create_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) + + def delete_entity_filter_contexts( + self, + workspace_id, + object_id, + **kwargs + ): + """Delete a Filter Context # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_entity_filter_contexts(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_filter_contexts( + self, + workspace_id, + **kwargs + ): + """Get all Filter Context # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_filter_contexts(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiFilterContextOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_filter_contexts_endpoint.call_with_http_info(**kwargs) + + def get_entity_filter_contexts( + self, + workspace_id, + object_id, + **kwargs + ): + """Get a Filter Context # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_filter_contexts(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiFilterContextOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) + + def patch_entity_filter_contexts( + self, + workspace_id, + object_id, + json_api_filter_context_patch_document, + **kwargs + ): + """Patch a Filter Context # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_filter_context_patch_document (JsonApiFilterContextPatchDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiFilterContextOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_filter_context_patch_document'] = \ + json_api_filter_context_patch_document + return self.patch_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) + + def search_entities_filter_contexts( + self, + workspace_id, + entity_search_body, + **kwargs + ): + """The search endpoint (beta) # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_entities_filter_contexts(workspace_id, entity_search_body, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiFilterContextOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['entity_search_body'] = \ + entity_search_body + return self.search_entities_filter_contexts_endpoint.call_with_http_info(**kwargs) + + def update_entity_filter_contexts( + self, + workspace_id, + object_id, + json_api_filter_context_in_document, + **kwargs + ): + """Put a Filter Context # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_filter_context_in_document (JsonApiFilterContextInDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiFilterContextOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_filter_context_in_document'] = \ + json_api_filter_context_in_document + return self.update_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/filter_view_controller_api.py b/gooddata-api-client/gooddata_api_client/api/filter_view_controller_api.py new file mode 100644 index 000000000..24085476e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/filter_view_controller_api.py @@ -0,0 +1,1242 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint +from gooddata_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from gooddata_api_client.model.entity_search_body import EntitySearchBody +from gooddata_api_client.model.json_api_filter_view_in_document import JsonApiFilterViewInDocument +from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +from gooddata_api_client.model.json_api_filter_view_out_list import JsonApiFilterViewOutList +from gooddata_api_client.model.json_api_filter_view_patch_document import JsonApiFilterViewPatchDocument + + +class FilterViewControllerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_entity_filter_views_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiFilterViewOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews', + 'operation_id': 'create_entity_filter_views', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_filter_view_in_document', + 'include', + ], + 'required': [ + 'workspace_id', + 'json_api_filter_view_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "ANALYTICALDASHBOARDS": "analyticalDashboards", + "USERS": "users", + "ANALYTICALDASHBOARD": "analyticalDashboard", + "USER": "user", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'json_api_filter_view_in_document': + (JsonApiFilterViewInDocument,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_filter_view_in_document': 'body', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.delete_entity_filter_views_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', + 'operation_id': 'delete_entity_filter_views', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_entities_filter_views_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiFilterViewOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews', + 'operation_id': 'get_all_entities_filter_views', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'origin', + 'filter', + 'include', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('include',): { + + "ANALYTICALDASHBOARDS": "analyticalDashboards", + "USERS": "users", + "ANALYTICALDASHBOARD": "analyticalDashboard", + "USER": "user", + "ALL": "ALL" + }, + ('meta_include',): { + + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'origin': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'filter': 'filter', + 'include': 'include', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'origin': 'query', + 'filter': 'query', + 'include': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_filter_views_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiFilterViewOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', + 'operation_id': 'get_entity_filter_views', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + 'include', + 'x_gdc_validate_relations', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "ANALYTICALDASHBOARDS": "analyticalDashboards", + "USERS": "users", + "ANALYTICALDASHBOARD": "analyticalDashboard", + "USER": "user", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'x_gdc_validate_relations': + (bool,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + 'include': 'query', + 'x_gdc_validate_relations': 'header', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.patch_entity_filter_views_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiFilterViewOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', + 'operation_id': 'patch_entity_filter_views', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_filter_view_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_filter_view_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "ANALYTICALDASHBOARDS": "analyticalDashboards", + "USERS": "users", + "ANALYTICALDASHBOARD": "analyticalDashboard", + "USER": "user", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_filter_view_patch_document': + (JsonApiFilterViewPatchDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_filter_view_patch_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.search_entities_filter_views_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiFilterViewOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews/search', + 'operation_id': 'search_entities_filter_views', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'entity_search_body', + 'origin', + 'x_gdc_validate_relations', + ], + 'required': [ + 'workspace_id', + 'entity_search_body', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'entity_search_body': + (EntitySearchBody,), + 'origin': + (str,), + 'x_gdc_validate_relations': + (bool,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + }, + 'location_map': { + 'workspace_id': 'path', + 'entity_search_body': 'body', + 'origin': 'query', + 'x_gdc_validate_relations': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_entity_filter_views_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiFilterViewOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', + 'operation_id': 'update_entity_filter_views', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_filter_view_in_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_filter_view_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "ANALYTICALDASHBOARDS": "analyticalDashboards", + "USERS": "users", + "ANALYTICALDASHBOARD": "analyticalDashboard", + "USER": "user", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_filter_view_in_document': + (JsonApiFilterViewInDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_filter_view_in_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + + def create_entity_filter_views( + self, + workspace_id, + json_api_filter_view_in_document, + **kwargs + ): + """Post Filter views # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_filter_views(workspace_id, json_api_filter_view_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_filter_view_in_document (JsonApiFilterViewInDocument): + + Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiFilterViewOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['json_api_filter_view_in_document'] = \ + json_api_filter_view_in_document + return self.create_entity_filter_views_endpoint.call_with_http_info(**kwargs) + + def delete_entity_filter_views( + self, + workspace_id, + object_id, + **kwargs + ): + """Delete Filter view # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_entity_filter_views(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_filter_views_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_filter_views( + self, + workspace_id, + **kwargs + ): + """Get all Filter views # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_filter_views(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiFilterViewOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_filter_views_endpoint.call_with_http_info(**kwargs) + + def get_entity_filter_views( + self, + workspace_id, + object_id, + **kwargs + ): + """Get Filter view # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_filter_views(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiFilterViewOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_filter_views_endpoint.call_with_http_info(**kwargs) + + def patch_entity_filter_views( + self, + workspace_id, + object_id, + json_api_filter_view_patch_document, + **kwargs + ): + """Patch Filter view # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_entity_filter_views(workspace_id, object_id, json_api_filter_view_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_filter_view_patch_document (JsonApiFilterViewPatchDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiFilterViewOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_filter_view_patch_document'] = \ + json_api_filter_view_patch_document + return self.patch_entity_filter_views_endpoint.call_with_http_info(**kwargs) + + def search_entities_filter_views( + self, + workspace_id, + entity_search_body, + **kwargs + ): + """The search endpoint (beta) # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_entities_filter_views(workspace_id, entity_search_body, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiFilterViewOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['entity_search_body'] = \ + entity_search_body + return self.search_entities_filter_views_endpoint.call_with_http_info(**kwargs) + + def update_entity_filter_views( + self, + workspace_id, + object_id, + json_api_filter_view_in_document, + **kwargs + ): + """Put Filter views # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_entity_filter_views(workspace_id, object_id, json_api_filter_view_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_filter_view_in_document (JsonApiFilterViewInDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiFilterViewOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_filter_view_in_document'] = \ + json_api_filter_view_in_document + return self.update_entity_filter_views_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/filter_views_api.py b/gooddata-api-client/gooddata_api_client/api/filter_views_api.py index 29db7d7fe..a809cce10 100644 --- a/gooddata-api-client/gooddata_api_client/api/filter_views_api.py +++ b/gooddata-api-client/gooddata_api_client/api/filter_views_api.py @@ -1265,7 +1265,7 @@ def search_entities_filter_views( entity_search_body, **kwargs ): - """Search request for FilterView # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/geographic_data_api.py b/gooddata-api-client/gooddata_api_client/api/geographic_data_api.py index 20f09611f..7f0734f6d 100644 --- a/gooddata-api-client/gooddata_api_client/api/geographic_data_api.py +++ b/gooddata-api-client/gooddata_api_client/api/geographic_data_api.py @@ -439,7 +439,7 @@ def create_entity_custom_geo_collections( json_api_custom_geo_collection_in_document, **kwargs ): - """create_entity_custom_geo_collections # noqa: E501 + """Post Custom Geo Collections # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -521,7 +521,7 @@ def delete_entity_custom_geo_collections( id, **kwargs ): - """delete_entity_custom_geo_collections # noqa: E501 + """Delete Custom Geo Collection # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -603,7 +603,7 @@ def get_all_entities_custom_geo_collections( self, **kwargs ): - """get_all_entities_custom_geo_collections # noqa: E501 + """Get all Custom Geo Collections # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -686,7 +686,7 @@ def get_entity_custom_geo_collections( id, **kwargs ): - """get_entity_custom_geo_collections # noqa: E501 + """Get Custom Geo Collection # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -770,7 +770,7 @@ def patch_entity_custom_geo_collections( json_api_custom_geo_collection_patch_document, **kwargs ): - """patch_entity_custom_geo_collections # noqa: E501 + """Patch Custom Geo Collection # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -857,7 +857,7 @@ def update_entity_custom_geo_collections( json_api_custom_geo_collection_in_document, **kwargs ): - """update_entity_custom_geo_collections # noqa: E501 + """Put Custom Geo Collection # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/jwk_controller_api.py b/gooddata-api-client/gooddata_api_client/api/jwk_controller_api.py new file mode 100644 index 000000000..6fcbfc9cd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/jwk_controller_api.py @@ -0,0 +1,946 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint +from gooddata_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from gooddata_api_client.model.json_api_jwk_in_document import JsonApiJwkInDocument +from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument +from gooddata_api_client.model.json_api_jwk_out_list import JsonApiJwkOutList +from gooddata_api_client.model.json_api_jwk_patch_document import JsonApiJwkPatchDocument + + +class JwkControllerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_entity_jwks_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiJwkOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/jwks', + 'operation_id': 'create_entity_jwks', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'json_api_jwk_in_document', + ], + 'required': [ + 'json_api_jwk_in_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'json_api_jwk_in_document': + (JsonApiJwkInDocument,), + }, + 'attribute_map': { + }, + 'location_map': { + 'json_api_jwk_in_document': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.delete_entity_jwks_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/jwks/{id}', + 'operation_id': 'delete_entity_jwks', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'filter', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'filter': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + }, + 'location_map': { + 'id': 'path', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_entities_jwks_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiJwkOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/jwks', + 'operation_id': 'get_all_entities_jwks', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'filter', + 'page', + 'size', + 'sort', + 'meta_include', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('meta_include',): { + + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'filter': + (str,), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'filter': 'filter', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'filter': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_jwks_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiJwkOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/jwks/{id}', + 'operation_id': 'get_entity_jwks', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'filter', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'filter': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + }, + 'location_map': { + 'id': 'path', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.patch_entity_jwks_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiJwkOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/jwks/{id}', + 'operation_id': 'patch_entity_jwks', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'json_api_jwk_patch_document', + 'filter', + ], + 'required': [ + 'id', + 'json_api_jwk_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'json_api_jwk_patch_document': + (JsonApiJwkPatchDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + }, + 'location_map': { + 'id': 'path', + 'json_api_jwk_patch_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.update_entity_jwks_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiJwkOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/jwks/{id}', + 'operation_id': 'update_entity_jwks', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'json_api_jwk_in_document', + 'filter', + ], + 'required': [ + 'id', + 'json_api_jwk_in_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'json_api_jwk_in_document': + (JsonApiJwkInDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + }, + 'location_map': { + 'id': 'path', + 'json_api_jwk_in_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + + def create_entity_jwks( + self, + json_api_jwk_in_document, + **kwargs + ): + """Post Jwks # noqa: E501 + + Creates JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_jwks(json_api_jwk_in_document, async_req=True) + >>> result = thread.get() + + Args: + json_api_jwk_in_document (JsonApiJwkInDocument): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiJwkOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['json_api_jwk_in_document'] = \ + json_api_jwk_in_document + return self.create_entity_jwks_endpoint.call_with_http_info(**kwargs) + + def delete_entity_jwks( + self, + id, + **kwargs + ): + """Delete Jwk # noqa: E501 + + Deletes JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_entity_jwks(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_entity_jwks_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_jwks( + self, + **kwargs + ): + """Get all Jwks # noqa: E501 + + Returns all JSON web keys - used to verify JSON web tokens (Jwts) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_jwks(async_req=True) + >>> result = thread.get() + + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiJwkOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_all_entities_jwks_endpoint.call_with_http_info(**kwargs) + + def get_entity_jwks( + self, + id, + **kwargs + ): + """Get Jwk # noqa: E501 + + Returns JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_jwks(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiJwkOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_entity_jwks_endpoint.call_with_http_info(**kwargs) + + def patch_entity_jwks( + self, + id, + json_api_jwk_patch_document, + **kwargs + ): + """Patch Jwk # noqa: E501 + + Patches JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_entity_jwks(id, json_api_jwk_patch_document, async_req=True) + >>> result = thread.get() + + Args: + id (str): + json_api_jwk_patch_document (JsonApiJwkPatchDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiJwkOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + kwargs['json_api_jwk_patch_document'] = \ + json_api_jwk_patch_document + return self.patch_entity_jwks_endpoint.call_with_http_info(**kwargs) + + def update_entity_jwks( + self, + id, + json_api_jwk_in_document, + **kwargs + ): + """Put Jwk # noqa: E501 + + Updates JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_entity_jwks(id, json_api_jwk_in_document, async_req=True) + >>> result = thread.get() + + Args: + id (str): + json_api_jwk_in_document (JsonApiJwkInDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiJwkOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + kwargs['json_api_jwk_in_document'] = \ + json_api_jwk_in_document + return self.update_entity_jwks_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/label_controller_api.py b/gooddata-api-client/gooddata_api_client/api/label_controller_api.py new file mode 100644 index 000000000..d17e69a18 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/label_controller_api.py @@ -0,0 +1,773 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint +from gooddata_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from gooddata_api_client.model.entity_search_body import EntitySearchBody +from gooddata_api_client.model.json_api_label_out_document import JsonApiLabelOutDocument +from gooddata_api_client.model.json_api_label_out_list import JsonApiLabelOutList +from gooddata_api_client.model.json_api_label_patch_document import JsonApiLabelPatchDocument + + +class LabelControllerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_all_entities_labels_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiLabelOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/labels', + 'operation_id': 'get_all_entities_labels', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'origin', + 'filter', + 'include', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('include',): { + + "ATTRIBUTES": "attributes", + "ATTRIBUTE": "attribute", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'origin': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'filter': 'filter', + 'include': 'include', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'origin': 'query', + 'filter': 'query', + 'include': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_labels_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiLabelOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/labels/{objectId}', + 'operation_id': 'get_entity_labels', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + 'include', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "ATTRIBUTES": "attributes", + "ATTRIBUTE": "attribute", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + 'include': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.patch_entity_labels_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiLabelOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/labels/{objectId}', + 'operation_id': 'patch_entity_labels', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_label_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_label_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "ATTRIBUTES": "attributes", + "ATTRIBUTE": "attribute", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_label_patch_document': + (JsonApiLabelPatchDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_label_patch_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.search_entities_labels_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiLabelOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/labels/search', + 'operation_id': 'search_entities_labels', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'entity_search_body', + 'origin', + 'x_gdc_validate_relations', + ], + 'required': [ + 'workspace_id', + 'entity_search_body', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'entity_search_body': + (EntitySearchBody,), + 'origin': + (str,), + 'x_gdc_validate_relations': + (bool,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + }, + 'location_map': { + 'workspace_id': 'path', + 'entity_search_body': 'body', + 'origin': 'query', + 'x_gdc_validate_relations': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def get_all_entities_labels( + self, + workspace_id, + **kwargs + ): + """Get all Labels # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_labels(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiLabelOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_labels_endpoint.call_with_http_info(**kwargs) + + def get_entity_labels( + self, + workspace_id, + object_id, + **kwargs + ): + """Get a Label # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_labels(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiLabelOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_labels_endpoint.call_with_http_info(**kwargs) + + def patch_entity_labels( + self, + workspace_id, + object_id, + json_api_label_patch_document, + **kwargs + ): + """Patch a Label (beta) # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_entity_labels(workspace_id, object_id, json_api_label_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_label_patch_document (JsonApiLabelPatchDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiLabelOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_label_patch_document'] = \ + json_api_label_patch_document + return self.patch_entity_labels_endpoint.call_with_http_info(**kwargs) + + def search_entities_labels( + self, + workspace_id, + entity_search_body, + **kwargs + ): + """The search endpoint (beta) # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_entities_labels(workspace_id, entity_search_body, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiLabelOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['entity_search_body'] = \ + entity_search_body + return self.search_entities_labels_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/labels_api.py b/gooddata-api-client/gooddata_api_client/api/labels_api.py index e7027d49c..3846e0979 100644 --- a/gooddata-api-client/gooddata_api_client/api/labels_api.py +++ b/gooddata-api-client/gooddata_api_client/api/labels_api.py @@ -689,7 +689,7 @@ def search_entities_labels( entity_search_body, **kwargs ): - """Search request for Label # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/metric_controller_api.py b/gooddata-api-client/gooddata_api_client/api/metric_controller_api.py new file mode 100644 index 000000000..f728d69d5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/metric_controller_api.py @@ -0,0 +1,1305 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint +from gooddata_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from gooddata_api_client.model.entity_search_body import EntitySearchBody +from gooddata_api_client.model.json_api_metric_in_document import JsonApiMetricInDocument +from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.model.json_api_metric_out_list import JsonApiMetricOutList +from gooddata_api_client.model.json_api_metric_patch_document import JsonApiMetricPatchDocument +from gooddata_api_client.model.json_api_metric_post_optional_id_document import JsonApiMetricPostOptionalIdDocument + + +class MetricControllerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_entity_metrics_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiMetricOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/metrics', + 'operation_id': 'create_entity_metrics', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_metric_post_optional_id_document', + 'include', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_metric_post_optional_id_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "FACTS": "facts", + "ATTRIBUTES": "attributes", + "LABELS": "labels", + "METRICS": "metrics", + "DATASETS": "datasets", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'json_api_metric_post_optional_id_document': + (JsonApiMetricPostOptionalIdDocument,), + 'include': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'include': 'include', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_metric_post_optional_id_document': 'body', + 'include': 'query', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.delete_entity_metrics_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}', + 'operation_id': 'delete_entity_metrics', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_entities_metrics_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiMetricOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/metrics', + 'operation_id': 'get_all_entities_metrics', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'origin', + 'filter', + 'include', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "FACTS": "facts", + "ATTRIBUTES": "attributes", + "LABELS": "labels", + "METRICS": "metrics", + "DATASETS": "datasets", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'origin': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'filter': 'filter', + 'include': 'include', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'origin': 'query', + 'filter': 'query', + 'include': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_metrics_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiMetricOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}', + 'operation_id': 'get_entity_metrics', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + 'include', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "FACTS": "facts", + "ATTRIBUTES": "attributes", + "LABELS": "labels", + "METRICS": "metrics", + "DATASETS": "datasets", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + 'include': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.patch_entity_metrics_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiMetricOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}', + 'operation_id': 'patch_entity_metrics', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_metric_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_metric_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "FACTS": "facts", + "ATTRIBUTES": "attributes", + "LABELS": "labels", + "METRICS": "metrics", + "DATASETS": "datasets", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_metric_patch_document': + (JsonApiMetricPatchDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_metric_patch_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.search_entities_metrics_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiMetricOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/metrics/search', + 'operation_id': 'search_entities_metrics', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'entity_search_body', + 'origin', + 'x_gdc_validate_relations', + ], + 'required': [ + 'workspace_id', + 'entity_search_body', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'entity_search_body': + (EntitySearchBody,), + 'origin': + (str,), + 'x_gdc_validate_relations': + (bool,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + }, + 'location_map': { + 'workspace_id': 'path', + 'entity_search_body': 'body', + 'origin': 'query', + 'x_gdc_validate_relations': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_entity_metrics_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiMetricOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}', + 'operation_id': 'update_entity_metrics', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_metric_in_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_metric_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "FACTS": "facts", + "ATTRIBUTES": "attributes", + "LABELS": "labels", + "METRICS": "metrics", + "DATASETS": "datasets", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_metric_in_document': + (JsonApiMetricInDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_metric_in_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + + def create_entity_metrics( + self, + workspace_id, + json_api_metric_post_optional_id_document, + **kwargs + ): + """Post Metrics # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_metrics(workspace_id, json_api_metric_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_metric_post_optional_id_document (JsonApiMetricPostOptionalIdDocument): + + Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiMetricOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['json_api_metric_post_optional_id_document'] = \ + json_api_metric_post_optional_id_document + return self.create_entity_metrics_endpoint.call_with_http_info(**kwargs) + + def delete_entity_metrics( + self, + workspace_id, + object_id, + **kwargs + ): + """Delete a Metric # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_entity_metrics(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_metrics_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_metrics( + self, + workspace_id, + **kwargs + ): + """Get all Metrics # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_metrics(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiMetricOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_metrics_endpoint.call_with_http_info(**kwargs) + + def get_entity_metrics( + self, + workspace_id, + object_id, + **kwargs + ): + """Get a Metric # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_metrics(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiMetricOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_metrics_endpoint.call_with_http_info(**kwargs) + + def patch_entity_metrics( + self, + workspace_id, + object_id, + json_api_metric_patch_document, + **kwargs + ): + """Patch a Metric # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_entity_metrics(workspace_id, object_id, json_api_metric_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_metric_patch_document (JsonApiMetricPatchDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiMetricOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_metric_patch_document'] = \ + json_api_metric_patch_document + return self.patch_entity_metrics_endpoint.call_with_http_info(**kwargs) + + def search_entities_metrics( + self, + workspace_id, + entity_search_body, + **kwargs + ): + """The search endpoint (beta) # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_entities_metrics(workspace_id, entity_search_body, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiMetricOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['entity_search_body'] = \ + entity_search_body + return self.search_entities_metrics_endpoint.call_with_http_info(**kwargs) + + def update_entity_metrics( + self, + workspace_id, + object_id, + json_api_metric_in_document, + **kwargs + ): + """Put a Metric # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_entity_metrics(workspace_id, object_id, json_api_metric_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_metric_in_document (JsonApiMetricInDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiMetricOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_metric_in_document'] = \ + json_api_metric_in_document + return self.update_entity_metrics_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/metrics_api.py b/gooddata-api-client/gooddata_api_client/api/metrics_api.py index 914bce346..fbf3be194 100644 --- a/gooddata-api-client/gooddata_api_client/api/metrics_api.py +++ b/gooddata-api-client/gooddata_api_client/api/metrics_api.py @@ -1129,7 +1129,7 @@ def search_entities_metrics( entity_search_body, **kwargs ): - """Search request for Metric # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/organization_entity_controller_api.py b/gooddata-api-client/gooddata_api_client/api/organization_entity_controller_api.py new file mode 100644 index 000000000..583490ef5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/organization_entity_controller_api.py @@ -0,0 +1,572 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint +from gooddata_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from gooddata_api_client.model.json_api_organization_in_document import JsonApiOrganizationInDocument +from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client.model.json_api_organization_patch_document import JsonApiOrganizationPatchDocument + + +class OrganizationEntityControllerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_entity_organizations_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiOrganizationOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/admin/organizations/{id}', + 'operation_id': 'get_entity_organizations', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'filter', + 'include', + 'meta_include', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'id', + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "USERS": "users", + "USERGROUPS": "userGroups", + "IDENTITYPROVIDERS": "identityProviders", + "BOOTSTRAPUSER": "bootstrapUser", + "BOOTSTRAPUSERGROUP": "bootstrapUserGroup", + "IDENTITYPROVIDER": "identityProvider", + "ALL": "ALL" + }, + ('meta_include',): { + + "PERMISSIONS": "permissions", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'id': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + 'include': 'include', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'id': 'path', + 'filter': 'query', + 'include': 'query', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.patch_entity_organizations_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiOrganizationOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/admin/organizations/{id}', + 'operation_id': 'patch_entity_organizations', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'json_api_organization_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'id', + 'json_api_organization_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('include',): { + + "USERS": "users", + "USERGROUPS": "userGroups", + "IDENTITYPROVIDERS": "identityProviders", + "BOOTSTRAPUSER": "bootstrapUser", + "BOOTSTRAPUSERGROUP": "bootstrapUserGroup", + "IDENTITYPROVIDER": "identityProvider", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'id': + (str,), + 'json_api_organization_patch_document': + (JsonApiOrganizationPatchDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'id': 'path', + 'json_api_organization_patch_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.update_entity_organizations_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiOrganizationOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/admin/organizations/{id}', + 'operation_id': 'update_entity_organizations', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'json_api_organization_in_document', + 'filter', + 'include', + ], + 'required': [ + 'id', + 'json_api_organization_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('include',): { + + "USERS": "users", + "USERGROUPS": "userGroups", + "IDENTITYPROVIDERS": "identityProviders", + "BOOTSTRAPUSER": "bootstrapUser", + "BOOTSTRAPUSERGROUP": "bootstrapUserGroup", + "IDENTITYPROVIDER": "identityProvider", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'id': + (str,), + 'json_api_organization_in_document': + (JsonApiOrganizationInDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'id': 'path', + 'json_api_organization_in_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + + def get_entity_organizations( + self, + id, + **kwargs + ): + """Get Organizations # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_organizations(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiOrganizationOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_entity_organizations_endpoint.call_with_http_info(**kwargs) + + def patch_entity_organizations( + self, + id, + json_api_organization_patch_document, + **kwargs + ): + """Patch Organization # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_entity_organizations(id, json_api_organization_patch_document, async_req=True) + >>> result = thread.get() + + Args: + id (str): + json_api_organization_patch_document (JsonApiOrganizationPatchDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiOrganizationOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + kwargs['json_api_organization_patch_document'] = \ + json_api_organization_patch_document + return self.patch_entity_organizations_endpoint.call_with_http_info(**kwargs) + + def update_entity_organizations( + self, + id, + json_api_organization_in_document, + **kwargs + ): + """Put Organization # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_entity_organizations(id, json_api_organization_in_document, async_req=True) + >>> result = thread.get() + + Args: + id (str): + json_api_organization_in_document (JsonApiOrganizationInDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiOrganizationOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + kwargs['json_api_organization_in_document'] = \ + json_api_organization_in_document + return self.update_entity_organizations_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/organization_model_controller_api.py b/gooddata-api-client/gooddata_api_client/api/organization_model_controller_api.py index fbfbc7396..8e7737fbf 100644 --- a/gooddata-api-client/gooddata_api_client/api/organization_model_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/organization_model_controller_api.py @@ -30,16 +30,8 @@ from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument from gooddata_api_client.model.json_api_csp_directive_out_list import JsonApiCspDirectiveOutList from gooddata_api_client.model.json_api_csp_directive_patch_document import JsonApiCspDirectivePatchDocument -from gooddata_api_client.model.json_api_custom_geo_collection_in_document import JsonApiCustomGeoCollectionInDocument -from gooddata_api_client.model.json_api_custom_geo_collection_out_document import JsonApiCustomGeoCollectionOutDocument -from gooddata_api_client.model.json_api_custom_geo_collection_out_list import JsonApiCustomGeoCollectionOutList -from gooddata_api_client.model.json_api_custom_geo_collection_patch_document import JsonApiCustomGeoCollectionPatchDocument from gooddata_api_client.model.json_api_data_source_identifier_out_document import JsonApiDataSourceIdentifierOutDocument from gooddata_api_client.model.json_api_data_source_identifier_out_list import JsonApiDataSourceIdentifierOutList -from gooddata_api_client.model.json_api_data_source_in_document import JsonApiDataSourceInDocument -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument -from gooddata_api_client.model.json_api_data_source_out_list import JsonApiDataSourceOutList -from gooddata_api_client.model.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument from gooddata_api_client.model.json_api_entitlement_out_document import JsonApiEntitlementOutDocument from gooddata_api_client.model.json_api_entitlement_out_list import JsonApiEntitlementOutList from gooddata_api_client.model.json_api_export_template_in_document import JsonApiExportTemplateInDocument @@ -51,10 +43,6 @@ from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument from gooddata_api_client.model.json_api_identity_provider_out_list import JsonApiIdentityProviderOutList from gooddata_api_client.model.json_api_identity_provider_patch_document import JsonApiIdentityProviderPatchDocument -from gooddata_api_client.model.json_api_jwk_in_document import JsonApiJwkInDocument -from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument -from gooddata_api_client.model.json_api_jwk_out_list import JsonApiJwkOutList -from gooddata_api_client.model.json_api_jwk_patch_document import JsonApiJwkPatchDocument from gooddata_api_client.model.json_api_llm_endpoint_in_document import JsonApiLlmEndpointInDocument from gooddata_api_client.model.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument from gooddata_api_client.model.json_api_llm_endpoint_out_list import JsonApiLlmEndpointOutList @@ -209,127 +197,6 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.create_entity_custom_geo_collections_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCustomGeoCollectionOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/customGeoCollections', - 'operation_id': 'create_entity_custom_geo_collections', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_custom_geo_collection_in_document', - ], - 'required': [ - 'json_api_custom_geo_collection_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'json_api_custom_geo_collection_in_document': - (JsonApiCustomGeoCollectionInDocument,), - }, - 'attribute_map': { - }, - 'location_map': { - 'json_api_custom_geo_collection_in_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_data_sources_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDataSourceOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/dataSources', - 'operation_id': 'create_entity_data_sources', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_data_source_in_document', - 'meta_include', - ], - 'required': [ - 'json_api_data_source_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PERMISSIONS": "permissions", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'json_api_data_source_in_document': - (JsonApiDataSourceInDocument,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'json_api_data_source_in_document': 'body', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) self.create_entity_export_templates_endpoint = _Endpoint( settings={ 'response_type': (JsonApiExportTemplateOutDocument,), @@ -434,58 +301,6 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.create_entity_jwks_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiJwkOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/jwks', - 'operation_id': 'create_entity_jwks', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_jwk_in_document', - ], - 'required': [ - 'json_api_jwk_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'json_api_jwk_in_document': - (JsonApiJwkInDocument,), - }, - 'attribute_map': { - }, - 'location_map': { - 'json_api_jwk_in_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) self.create_entity_llm_endpoints_endpoint = _Endpoint( settings={ 'response_type': (JsonApiLlmEndpointOutDocument,), @@ -1078,12 +893,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_custom_geo_collections_endpoint = _Endpoint( + self.delete_entity_export_templates_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/customGeoCollections/{id}', - 'operation_id': 'delete_entity_custom_geo_collections', + 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', + 'operation_id': 'delete_entity_export_templates', 'http_method': 'DELETE', 'servers': None, }, @@ -1137,12 +952,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_data_sources_endpoint = _Endpoint( + self.delete_entity_identity_providers_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/dataSources/{id}', - 'operation_id': 'delete_entity_data_sources', + 'endpoint_path': '/api/v1/entities/identityProviders/{id}', + 'operation_id': 'delete_entity_identity_providers', 'http_method': 'DELETE', 'servers': None, }, @@ -1196,12 +1011,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_export_templates_endpoint = _Endpoint( + self.delete_entity_llm_endpoints_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', - 'operation_id': 'delete_entity_export_templates', + 'endpoint_path': '/api/v1/entities/llmEndpoints/{id}', + 'operation_id': 'delete_entity_llm_endpoints', 'http_method': 'DELETE', 'servers': None, }, @@ -1255,12 +1070,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_identity_providers_endpoint = _Endpoint( + self.delete_entity_llm_providers_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/identityProviders/{id}', - 'operation_id': 'delete_entity_identity_providers', + 'endpoint_path': '/api/v1/entities/llmProviders/{id}', + 'operation_id': 'delete_entity_llm_providers', 'http_method': 'DELETE', 'servers': None, }, @@ -1314,12 +1129,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_jwks_endpoint = _Endpoint( + self.delete_entity_notification_channels_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/jwks/{id}', - 'operation_id': 'delete_entity_jwks', + 'endpoint_path': '/api/v1/entities/notificationChannels/{id}', + 'operation_id': 'delete_entity_notification_channels', 'http_method': 'DELETE', 'servers': None, }, @@ -1373,12 +1188,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_llm_endpoints_endpoint = _Endpoint( + self.delete_entity_organization_settings_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/llmEndpoints/{id}', - 'operation_id': 'delete_entity_llm_endpoints', + 'endpoint_path': '/api/v1/entities/organizationSettings/{id}', + 'operation_id': 'delete_entity_organization_settings', 'http_method': 'DELETE', 'servers': None, }, @@ -1432,12 +1247,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_llm_providers_endpoint = _Endpoint( + self.delete_entity_themes_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/llmProviders/{id}', - 'operation_id': 'delete_entity_llm_providers', + 'endpoint_path': '/api/v1/entities/themes/{id}', + 'operation_id': 'delete_entity_themes', 'http_method': 'DELETE', 'servers': None, }, @@ -1491,12 +1306,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_notification_channels_endpoint = _Endpoint( + self.delete_entity_user_groups_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/notificationChannels/{id}', - 'operation_id': 'delete_entity_notification_channels', + 'endpoint_path': '/api/v1/entities/userGroups/{id}', + 'operation_id': 'delete_entity_user_groups', 'http_method': 'DELETE', 'servers': None, }, @@ -1550,12 +1365,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_organization_settings_endpoint = _Endpoint( + self.delete_entity_users_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/organizationSettings/{id}', - 'operation_id': 'delete_entity_organization_settings', + 'endpoint_path': '/api/v1/entities/users/{id}', + 'operation_id': 'delete_entity_users', 'http_method': 'DELETE', 'servers': None, }, @@ -1609,12 +1424,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_themes_endpoint = _Endpoint( + self.delete_entity_workspaces_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/themes/{id}', - 'operation_id': 'delete_entity_themes', + 'endpoint_path': '/api/v1/entities/workspaces/{id}', + 'operation_id': 'delete_entity_workspaces', 'http_method': 'DELETE', 'servers': None, }, @@ -1668,189 +1483,93 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_user_groups_endpoint = _Endpoint( + self.get_all_entities_color_palettes_endpoint = _Endpoint( settings={ - 'response_type': None, + 'response_type': (JsonApiColorPaletteOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/userGroups/{id}', - 'operation_id': 'delete_entity_user_groups', - 'http_method': 'DELETE', + 'endpoint_path': '/api/v1/entities/colorPalettes', + 'operation_id': 'get_all_entities_color_palettes', + 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ - 'id', 'filter', + 'page', + 'size', + 'sort', + 'meta_include', ], - 'required': [ - 'id', - ], + 'required': [], 'nullable': [ ], 'enum': [ + 'meta_include', ], 'validation': [ - 'id', + 'meta_include', ] }, root_map={ 'validations': { - ('id',): { + ('meta_include',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, }, }, 'allowed_values': { + ('meta_include',): { + + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, }, 'openapi_types': { - 'id': - (str,), 'filter': (str,), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'meta_include': + ([str],), }, 'attribute_map': { - 'id': 'id', 'filter': 'filter', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'meta_include': 'metaInclude', }, 'location_map': { - 'id': 'path', 'filter': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'meta_include': 'query', }, 'collection_format_map': { + 'sort': 'multi', + 'meta_include': 'csv', } }, headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_users_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{id}', - 'operation_id': 'delete_entity_users', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_workspaces_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{id}', - 'operation_id': 'delete_entity_workspaces', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], 'content_type': [], }, api_client=api_client ) - self.get_all_entities_color_palettes_endpoint = _Endpoint( + self.get_all_entities_csp_directives_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiColorPaletteOutList,), + 'response_type': (JsonApiCspDirectiveOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/colorPalettes', - 'operation_id': 'get_all_entities_color_palettes', + 'endpoint_path': '/api/v1/entities/cspDirectives', + 'operation_id': 'get_all_entities_csp_directives', 'http_method': 'GET', 'servers': None, }, @@ -1926,12 +1645,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_csp_directives_endpoint = _Endpoint( + self.get_all_entities_data_source_identifiers_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiCspDirectiveOutList,), + 'response_type': (JsonApiDataSourceIdentifierOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/cspDirectives', - 'operation_id': 'get_all_entities_csp_directives', + 'endpoint_path': '/api/v1/entities/dataSourceIdentifiers', + 'operation_id': 'get_all_entities_data_source_identifiers', 'http_method': 'GET', 'servers': None, }, @@ -1962,6 +1681,7 @@ def __init__(self, api_client=None): 'allowed_values': { ('meta_include',): { + "PERMISSIONS": "permissions", "PAGE": "page", "ALL": "all", "ALL": "ALL" @@ -2007,12 +1727,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_custom_geo_collections_endpoint = _Endpoint( + self.get_all_entities_entitlements_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiCustomGeoCollectionOutList,), + 'response_type': (JsonApiEntitlementOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/customGeoCollections', - 'operation_id': 'get_all_entities_custom_geo_collections', + 'endpoint_path': '/api/v1/entities/entitlements', + 'operation_id': 'get_all_entities_entitlements', 'http_method': 'GET', 'servers': None, }, @@ -2088,12 +1808,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_data_source_identifiers_endpoint = _Endpoint( + self.get_all_entities_export_templates_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiDataSourceIdentifierOutList,), + 'response_type': (JsonApiExportTemplateOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/dataSourceIdentifiers', - 'operation_id': 'get_all_entities_data_source_identifiers', + 'endpoint_path': '/api/v1/entities/exportTemplates', + 'operation_id': 'get_all_entities_export_templates', 'http_method': 'GET', 'servers': None, }, @@ -2124,7 +1844,6 @@ def __init__(self, api_client=None): 'allowed_values': { ('meta_include',): { - "PERMISSIONS": "permissions", "PAGE": "page", "ALL": "all", "ALL": "ALL" @@ -2170,12 +1889,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_data_sources_endpoint = _Endpoint( + self.get_all_entities_identity_providers_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiDataSourceOutList,), + 'response_type': (JsonApiIdentityProviderOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/dataSources', - 'operation_id': 'get_all_entities_data_sources', + 'endpoint_path': '/api/v1/entities/identityProviders', + 'operation_id': 'get_all_entities_identity_providers', 'http_method': 'GET', 'servers': None, }, @@ -2206,7 +1925,6 @@ def __init__(self, api_client=None): 'allowed_values': { ('meta_include',): { - "PERMISSIONS": "permissions", "PAGE": "page", "ALL": "all", "ALL": "ALL" @@ -2252,12 +1970,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_entitlements_endpoint = _Endpoint( + self.get_all_entities_llm_endpoints_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiEntitlementOutList,), + 'response_type': (JsonApiLlmEndpointOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/entitlements', - 'operation_id': 'get_all_entities_entitlements', + 'endpoint_path': '/api/v1/entities/llmEndpoints', + 'operation_id': 'get_all_entities_llm_endpoints', 'http_method': 'GET', 'servers': None, }, @@ -2333,12 +2051,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_export_templates_endpoint = _Endpoint( + self.get_all_entities_llm_providers_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiExportTemplateOutList,), + 'response_type': (JsonApiLlmProviderOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/exportTemplates', - 'operation_id': 'get_all_entities_export_templates', + 'endpoint_path': '/api/v1/entities/llmProviders', + 'operation_id': 'get_all_entities_llm_providers', 'http_method': 'GET', 'servers': None, }, @@ -2414,12 +2132,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_identity_providers_endpoint = _Endpoint( + self.get_all_entities_notification_channel_identifiers_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiIdentityProviderOutList,), + 'response_type': (JsonApiNotificationChannelIdentifierOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/identityProviders', - 'operation_id': 'get_all_entities_identity_providers', + 'endpoint_path': '/api/v1/entities/notificationChannelIdentifiers', + 'operation_id': 'get_all_entities_notification_channel_identifiers', 'http_method': 'GET', 'servers': None, }, @@ -2495,12 +2213,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_jwks_endpoint = _Endpoint( + self.get_all_entities_notification_channels_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiJwkOutList,), + 'response_type': (JsonApiNotificationChannelOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/jwks', - 'operation_id': 'get_all_entities_jwks', + 'endpoint_path': '/api/v1/entities/notificationChannels', + 'operation_id': 'get_all_entities_notification_channels', 'http_method': 'GET', 'servers': None, }, @@ -2576,12 +2294,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_llm_endpoints_endpoint = _Endpoint( + self.get_all_entities_organization_settings_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiLlmEndpointOutList,), + 'response_type': (JsonApiOrganizationSettingOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/llmEndpoints', - 'operation_id': 'get_all_entities_llm_endpoints', + 'endpoint_path': '/api/v1/entities/organizationSettings', + 'operation_id': 'get_all_entities_organization_settings', 'http_method': 'GET', 'servers': None, }, @@ -2657,12 +2375,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_llm_providers_endpoint = _Endpoint( + self.get_all_entities_themes_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiLlmProviderOutList,), + 'response_type': (JsonApiThemeOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/llmProviders', - 'operation_id': 'get_all_entities_llm_providers', + 'endpoint_path': '/api/v1/entities/themes', + 'operation_id': 'get_all_entities_themes', 'http_method': 'GET', 'servers': None, }, @@ -2738,18 +2456,19 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_notification_channel_identifiers_endpoint = _Endpoint( + self.get_all_entities_user_groups_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiNotificationChannelIdentifierOutList,), + 'response_type': (JsonApiUserGroupOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/notificationChannelIdentifiers', - 'operation_id': 'get_all_entities_notification_channel_identifiers', + 'endpoint_path': '/api/v1/entities/userGroups', + 'operation_id': 'get_all_entities_user_groups', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ 'filter', + 'include', 'page', 'size', 'sort', @@ -2759,6 +2478,7 @@ def __init__(self, api_client=None): 'nullable': [ ], 'enum': [ + 'include', 'meta_include', ], 'validation': [ @@ -2772,6 +2492,12 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { + ('include',): { + + "USERGROUPS": "userGroups", + "PARENTS": "parents", + "ALL": "ALL" + }, ('meta_include',): { "PAGE": "page", @@ -2782,6 +2508,8 @@ def __init__(self, api_client=None): 'openapi_types': { 'filter': (str,), + 'include': + ([str],), 'page': (int,), 'size': @@ -2793,6 +2521,7 @@ def __init__(self, api_client=None): }, 'attribute_map': { 'filter': 'filter', + 'include': 'include', 'page': 'page', 'size': 'size', 'sort': 'sort', @@ -2800,12 +2529,14 @@ def __init__(self, api_client=None): }, 'location_map': { 'filter': 'query', + 'include': 'query', 'page': 'query', 'size': 'query', 'sort': 'query', 'meta_include': 'query', }, 'collection_format_map': { + 'include': 'csv', 'sort': 'multi', 'meta_include': 'csv', } @@ -2819,12 +2550,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_notification_channels_endpoint = _Endpoint( + self.get_all_entities_user_identifiers_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiNotificationChannelOutList,), + 'response_type': (JsonApiUserIdentifierOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/notificationChannels', - 'operation_id': 'get_all_entities_notification_channels', + 'endpoint_path': '/api/v1/entities/userIdentifiers', + 'operation_id': 'get_all_entities_user_identifiers', 'http_method': 'GET', 'servers': None, }, @@ -2900,18 +2631,19 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_organization_settings_endpoint = _Endpoint( + self.get_all_entities_users_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiOrganizationSettingOutList,), + 'response_type': (JsonApiUserOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/organizationSettings', - 'operation_id': 'get_all_entities_organization_settings', + 'endpoint_path': '/api/v1/entities/users', + 'operation_id': 'get_all_entities_users', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ 'filter', + 'include', 'page', 'size', 'sort', @@ -2921,6 +2653,7 @@ def __init__(self, api_client=None): 'nullable': [ ], 'enum': [ + 'include', 'meta_include', ], 'validation': [ @@ -2934,6 +2667,11 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { + ('include',): { + + "USERGROUPS": "userGroups", + "ALL": "ALL" + }, ('meta_include',): { "PAGE": "page", @@ -2944,6 +2682,8 @@ def __init__(self, api_client=None): 'openapi_types': { 'filter': (str,), + 'include': + ([str],), 'page': (int,), 'size': @@ -2955,6 +2695,7 @@ def __init__(self, api_client=None): }, 'attribute_map': { 'filter': 'filter', + 'include': 'include', 'page': 'page', 'size': 'size', 'sort': 'sort', @@ -2962,12 +2703,14 @@ def __init__(self, api_client=None): }, 'location_map': { 'filter': 'query', + 'include': 'query', 'page': 'query', 'size': 'query', 'sort': 'query', 'meta_include': 'query', }, 'collection_format_map': { + 'include': 'csv', 'sort': 'multi', 'meta_include': 'csv', } @@ -2981,18 +2724,19 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_themes_endpoint = _Endpoint( + self.get_all_entities_workspaces_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiThemeOutList,), + 'response_type': (JsonApiWorkspaceOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/themes', - 'operation_id': 'get_all_entities_themes', + 'endpoint_path': '/api/v1/entities/workspaces', + 'operation_id': 'get_all_entities_workspaces', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ 'filter', + 'include', 'page', 'size', 'sort', @@ -3002,6 +2746,7 @@ def __init__(self, api_client=None): 'nullable': [ ], 'enum': [ + 'include', 'meta_include', ], 'validation': [ @@ -3015,8 +2760,18 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { - ('meta_include',): { + ('include',): { + + "WORKSPACES": "workspaces", + "PARENT": "parent", + "ALL": "ALL" + }, + ('meta_include',): { + "CONFIG": "config", + "PERMISSIONS": "permissions", + "HIERARCHY": "hierarchy", + "DATAMODELDATASETS": "dataModelDatasets", "PAGE": "page", "ALL": "all", "ALL": "ALL" @@ -3025,6 +2780,8 @@ def __init__(self, api_client=None): 'openapi_types': { 'filter': (str,), + 'include': + ([str],), 'page': (int,), 'size': @@ -3036,6 +2793,7 @@ def __init__(self, api_client=None): }, 'attribute_map': { 'filter': 'filter', + 'include': 'include', 'page': 'page', 'size': 'size', 'sort': 'sort', @@ -3043,12 +2801,14 @@ def __init__(self, api_client=None): }, 'location_map': { 'filter': 'query', + 'include': 'query', 'page': 'query', 'size': 'query', 'sort': 'query', 'meta_include': 'query', }, 'collection_format_map': { + 'include': 'csv', 'sort': 'multi', 'meta_include': 'csv', } @@ -3062,89 +2822,57 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_user_groups_endpoint = _Endpoint( + self.get_entity_color_palettes_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiUserGroupOutList,), + 'response_type': (JsonApiColorPaletteOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/userGroups', - 'operation_id': 'get_all_entities_user_groups', + 'endpoint_path': '/api/v1/entities/colorPalettes/{id}', + 'operation_id': 'get_entity_color_palettes', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ + 'id', 'filter', - 'include', - 'page', - 'size', - 'sort', - 'meta_include', ], - 'required': [], + 'required': [ + 'id', + ], 'nullable': [ ], 'enum': [ - 'include', - 'meta_include', ], 'validation': [ - 'meta_include', + 'id', ] }, root_map={ 'validations': { - ('meta_include',): { + ('id',): { + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, }, }, 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "PARENTS": "parents", - "ALL": "ALL" - }, - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, }, 'openapi_types': { + 'id': + (str,), 'filter': (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), }, 'attribute_map': { + 'id': 'id', 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', }, 'location_map': { + 'id': 'path', 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', }, 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', } }, headers_map={ @@ -3156,76 +2884,57 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_user_identifiers_endpoint = _Endpoint( + self.get_entity_csp_directives_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiUserIdentifierOutList,), + 'response_type': (JsonApiCspDirectiveOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/userIdentifiers', - 'operation_id': 'get_all_entities_user_identifiers', + 'endpoint_path': '/api/v1/entities/cspDirectives/{id}', + 'operation_id': 'get_entity_csp_directives', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ + 'id', 'filter', - 'page', - 'size', - 'sort', - 'meta_include', ], - 'required': [], + 'required': [ + 'id', + ], 'nullable': [ ], 'enum': [ - 'meta_include', ], 'validation': [ - 'meta_include', + 'id', ] }, root_map={ 'validations': { - ('meta_include',): { + ('id',): { + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, }, }, 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, }, 'openapi_types': { + 'id': + (str,), 'filter': (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), }, 'attribute_map': { + 'id': 'id', 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', }, 'location_map': { + 'id': 'path', 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', }, 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', } }, headers_map={ @@ -3237,87 +2946,73 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_users_endpoint = _Endpoint( + self.get_entity_data_source_identifiers_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiUserOutList,), + 'response_type': (JsonApiDataSourceIdentifierOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/users', - 'operation_id': 'get_all_entities_users', + 'endpoint_path': '/api/v1/entities/dataSourceIdentifiers/{id}', + 'operation_id': 'get_entity_data_source_identifiers', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ + 'id', 'filter', - 'include', - 'page', - 'size', - 'sort', 'meta_include', ], - 'required': [], + 'required': [ + 'id', + ], 'nullable': [ ], 'enum': [ - 'include', 'meta_include', ], 'validation': [ + 'id', 'meta_include', ] }, root_map={ 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, ('meta_include',): { }, }, 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "ALL": "ALL" - }, ('meta_include',): { - "PAGE": "page", + "PERMISSIONS": "permissions", "ALL": "all", "ALL": "ALL" }, }, 'openapi_types': { + 'id': + (str,), 'filter': (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), 'meta_include': ([str],), }, 'attribute_map': { + 'id': 'id', 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', 'meta_include': 'metaInclude', }, 'location_map': { + 'id': 'path', 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', 'meta_include': 'query', }, 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', 'meta_include': 'csv', } }, @@ -3330,93 +3025,57 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_workspaces_endpoint = _Endpoint( + self.get_entity_entitlements_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiWorkspaceOutList,), + 'response_type': (JsonApiEntitlementOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces', - 'operation_id': 'get_all_entities_workspaces', + 'endpoint_path': '/api/v1/entities/entitlements/{id}', + 'operation_id': 'get_entity_entitlements', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ + 'id', 'filter', - 'include', - 'page', - 'size', - 'sort', - 'meta_include', ], - 'required': [], + 'required': [ + 'id', + ], 'nullable': [ ], 'enum': [ - 'include', - 'meta_include', ], 'validation': [ - 'meta_include', + 'id', ] }, root_map={ 'validations': { - ('meta_include',): { + ('id',): { + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, }, }, 'allowed_values': { - ('include',): { - - "WORKSPACES": "workspaces", - "PARENT": "parent", - "ALL": "ALL" - }, - ('meta_include',): { - - "CONFIG": "config", - "PERMISSIONS": "permissions", - "HIERARCHY": "hierarchy", - "DATAMODELDATASETS": "dataModelDatasets", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, }, 'openapi_types': { + 'id': + (str,), 'filter': (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), }, 'attribute_map': { + 'id': 'id', 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', }, 'location_map': { + 'id': 'path', 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', }, 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', } }, headers_map={ @@ -3428,12 +3087,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_color_palettes_endpoint = _Endpoint( + self.get_entity_export_templates_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiColorPaletteOutDocument,), + 'response_type': (JsonApiExportTemplateOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/colorPalettes/{id}', - 'operation_id': 'get_entity_color_palettes', + 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', + 'operation_id': 'get_entity_export_templates', 'http_method': 'GET', 'servers': None, }, @@ -3490,12 +3149,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_csp_directives_endpoint = _Endpoint( + self.get_entity_identity_providers_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiCspDirectiveOutDocument,), + 'response_type': (JsonApiIdentityProviderOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/cspDirectives/{id}', - 'operation_id': 'get_entity_csp_directives', + 'endpoint_path': '/api/v1/entities/identityProviders/{id}', + 'operation_id': 'get_entity_identity_providers', 'http_method': 'GET', 'servers': None, }, @@ -3552,12 +3211,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_custom_geo_collections_endpoint = _Endpoint( + self.get_entity_llm_endpoints_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiCustomGeoCollectionOutDocument,), + 'response_type': (JsonApiLlmEndpointOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/customGeoCollections/{id}', - 'operation_id': 'get_entity_custom_geo_collections', + 'endpoint_path': '/api/v1/entities/llmEndpoints/{id}', + 'operation_id': 'get_entity_llm_endpoints', 'http_method': 'GET', 'servers': None, }, @@ -3614,12 +3273,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_data_source_identifiers_endpoint = _Endpoint( + self.get_entity_llm_providers_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiDataSourceIdentifierOutDocument,), + 'response_type': (JsonApiLlmProviderOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/dataSourceIdentifiers/{id}', - 'operation_id': 'get_entity_data_source_identifiers', + 'endpoint_path': '/api/v1/entities/llmProviders/{id}', + 'operation_id': 'get_entity_llm_providers', 'http_method': 'GET', 'servers': None, }, @@ -3627,7 +3286,6 @@ def __init__(self, api_client=None): 'all': [ 'id', 'filter', - 'meta_include', ], 'required': [ 'id', @@ -3635,11 +3293,9 @@ def __init__(self, api_client=None): 'nullable': [ ], 'enum': [ - 'meta_include', ], 'validation': [ 'id', - 'meta_include', ] }, root_map={ @@ -3650,38 +3306,24 @@ def __init__(self, api_client=None): 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 }, }, - ('meta_include',): { - - }, }, 'allowed_values': { - ('meta_include',): { - - "PERMISSIONS": "permissions", - "ALL": "all", - "ALL": "ALL" - }, }, 'openapi_types': { 'id': (str,), 'filter': (str,), - 'meta_include': - ([str],), }, 'attribute_map': { 'id': 'id', 'filter': 'filter', - 'meta_include': 'metaInclude', }, 'location_map': { 'id': 'path', 'filter': 'query', - 'meta_include': 'query', }, 'collection_format_map': { - 'meta_include': 'csv', } }, headers_map={ @@ -3693,12 +3335,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_data_sources_endpoint = _Endpoint( + self.get_entity_notification_channel_identifiers_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiDataSourceOutDocument,), + 'response_type': (JsonApiNotificationChannelIdentifierOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/dataSources/{id}', - 'operation_id': 'get_entity_data_sources', + 'endpoint_path': '/api/v1/entities/notificationChannelIdentifiers/{id}', + 'operation_id': 'get_entity_notification_channel_identifiers', 'http_method': 'GET', 'servers': None, }, @@ -3706,7 +3348,6 @@ def __init__(self, api_client=None): 'all': [ 'id', 'filter', - 'meta_include', ], 'required': [ 'id', @@ -3714,11 +3355,9 @@ def __init__(self, api_client=None): 'nullable': [ ], 'enum': [ - 'meta_include', ], 'validation': [ 'id', - 'meta_include', ] }, root_map={ @@ -3729,38 +3368,24 @@ def __init__(self, api_client=None): 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 }, }, - ('meta_include',): { - - }, }, 'allowed_values': { - ('meta_include',): { - - "PERMISSIONS": "permissions", - "ALL": "all", - "ALL": "ALL" - }, }, 'openapi_types': { 'id': (str,), 'filter': (str,), - 'meta_include': - ([str],), }, 'attribute_map': { 'id': 'id', 'filter': 'filter', - 'meta_include': 'metaInclude', }, 'location_map': { 'id': 'path', 'filter': 'query', - 'meta_include': 'query', }, 'collection_format_map': { - 'meta_include': 'csv', } }, headers_map={ @@ -3772,12 +3397,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_entitlements_endpoint = _Endpoint( + self.get_entity_notification_channels_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiEntitlementOutDocument,), + 'response_type': (JsonApiNotificationChannelOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/entitlements/{id}', - 'operation_id': 'get_entity_entitlements', + 'endpoint_path': '/api/v1/entities/notificationChannels/{id}', + 'operation_id': 'get_entity_notification_channels', 'http_method': 'GET', 'servers': None, }, @@ -3834,12 +3459,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_export_templates_endpoint = _Endpoint( + self.get_entity_organization_settings_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiExportTemplateOutDocument,), + 'response_type': (JsonApiOrganizationSettingOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', - 'operation_id': 'get_entity_export_templates', + 'endpoint_path': '/api/v1/entities/organizationSettings/{id}', + 'operation_id': 'get_entity_organization_settings', 'http_method': 'GET', 'servers': None, }, @@ -3896,12 +3521,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_identity_providers_endpoint = _Endpoint( + self.get_entity_themes_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiIdentityProviderOutDocument,), + 'response_type': (JsonApiThemeOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/identityProviders/{id}', - 'operation_id': 'get_entity_identity_providers', + 'endpoint_path': '/api/v1/entities/themes/{id}', + 'operation_id': 'get_entity_themes', 'http_method': 'GET', 'servers': None, }, @@ -3958,12 +3583,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_jwks_endpoint = _Endpoint( + self.get_entity_user_groups_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiJwkOutDocument,), + 'response_type': (JsonApiUserGroupOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/jwks/{id}', - 'operation_id': 'get_entity_jwks', + 'endpoint_path': '/api/v1/entities/userGroups/{id}', + 'operation_id': 'get_entity_user_groups', 'http_method': 'GET', 'servers': None, }, @@ -3971,6 +3596,7 @@ def __init__(self, api_client=None): 'all': [ 'id', 'filter', + 'include', ], 'required': [ 'id', @@ -3978,6 +3604,7 @@ def __init__(self, api_client=None): 'nullable': [ ], 'enum': [ + 'include', ], 'validation': [ 'id', @@ -3993,22 +3620,33 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { + ('include',): { + + "USERGROUPS": "userGroups", + "PARENTS": "parents", + "ALL": "ALL" + }, }, 'openapi_types': { 'id': (str,), 'filter': (str,), + 'include': + ([str],), }, 'attribute_map': { 'id': 'id', 'filter': 'filter', + 'include': 'include', }, 'location_map': { 'id': 'path', 'filter': 'query', + 'include': 'query', }, 'collection_format_map': { + 'include': 'csv', } }, headers_map={ @@ -4020,12 +3658,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_llm_endpoints_endpoint = _Endpoint( + self.get_entity_user_identifiers_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiLlmEndpointOutDocument,), + 'response_type': (JsonApiUserIdentifierOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/llmEndpoints/{id}', - 'operation_id': 'get_entity_llm_endpoints', + 'endpoint_path': '/api/v1/entities/userIdentifiers/{id}', + 'operation_id': 'get_entity_user_identifiers', 'http_method': 'GET', 'servers': None, }, @@ -4082,12 +3720,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_llm_providers_endpoint = _Endpoint( + self.get_entity_users_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiLlmProviderOutDocument,), + 'response_type': (JsonApiUserOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/llmProviders/{id}', - 'operation_id': 'get_entity_llm_providers', + 'endpoint_path': '/api/v1/entities/users/{id}', + 'operation_id': 'get_entity_users', 'http_method': 'GET', 'servers': None, }, @@ -4095,6 +3733,7 @@ def __init__(self, api_client=None): 'all': [ 'id', 'filter', + 'include', ], 'required': [ 'id', @@ -4102,6 +3741,7 @@ def __init__(self, api_client=None): 'nullable': [ ], 'enum': [ + 'include', ], 'validation': [ 'id', @@ -4117,22 +3757,32 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { + ('include',): { + + "USERGROUPS": "userGroups", + "ALL": "ALL" + }, }, 'openapi_types': { 'id': (str,), 'filter': (str,), + 'include': + ([str],), }, 'attribute_map': { 'id': 'id', 'filter': 'filter', + 'include': 'include', }, 'location_map': { 'id': 'path', 'filter': 'query', + 'include': 'query', }, 'collection_format_map': { + 'include': 'csv', } }, headers_map={ @@ -4144,12 +3794,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_notification_channel_identifiers_endpoint = _Endpoint( + self.get_entity_workspaces_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiNotificationChannelIdentifierOutDocument,), + 'response_type': (JsonApiWorkspaceOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/notificationChannelIdentifiers/{id}', - 'operation_id': 'get_entity_notification_channel_identifiers', + 'endpoint_path': '/api/v1/entities/workspaces/{id}', + 'operation_id': 'get_entity_workspaces', 'http_method': 'GET', 'servers': None, }, @@ -4157,6 +3807,8 @@ def __init__(self, api_client=None): 'all': [ 'id', 'filter', + 'include', + 'meta_include', ], 'required': [ 'id', @@ -4164,9 +3816,12 @@ def __init__(self, api_client=None): 'nullable': [ ], 'enum': [ + 'include', + 'meta_include', ], 'validation': [ 'id', + 'meta_include', ] }, root_map={ @@ -4177,24 +3832,52 @@ def __init__(self, api_client=None): 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 }, }, + ('meta_include',): { + + }, }, 'allowed_values': { + ('include',): { + + "WORKSPACES": "workspaces", + "PARENT": "parent", + "ALL": "ALL" + }, + ('meta_include',): { + + "CONFIG": "config", + "PERMISSIONS": "permissions", + "HIERARCHY": "hierarchy", + "DATAMODELDATASETS": "dataModelDatasets", + "ALL": "all", + "ALL": "ALL" + }, }, 'openapi_types': { 'id': (str,), 'filter': (str,), + 'include': + ([str],), + 'meta_include': + ([str],), }, 'attribute_map': { 'id': 'id', 'filter': 'filter', + 'include': 'include', + 'meta_include': 'metaInclude', }, 'location_map': { 'id': 'path', 'filter': 'query', + 'include': 'query', + 'meta_include': 'query', }, 'collection_format_map': { + 'include': 'csv', + 'meta_include': 'csv', } }, headers_map={ @@ -4206,22 +3889,24 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_notification_channels_endpoint = _Endpoint( + self.patch_entity_color_palettes_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiNotificationChannelOutDocument,), + 'response_type': (JsonApiColorPaletteOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/notificationChannels/{id}', - 'operation_id': 'get_entity_notification_channels', - 'http_method': 'GET', + 'endpoint_path': '/api/v1/entities/colorPalettes/{id}', + 'operation_id': 'patch_entity_color_palettes', + 'http_method': 'PATCH', 'servers': None, }, params_map={ 'all': [ 'id', + 'json_api_color_palette_patch_document', 'filter', ], 'required': [ 'id', + 'json_api_color_palette_patch_document', ], 'nullable': [ ], @@ -4245,6 +3930,8 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), + 'json_api_color_palette_patch_document': + (JsonApiColorPalettePatchDocument,), 'filter': (str,), }, @@ -4254,6 +3941,7 @@ def __init__(self, api_client=None): }, 'location_map': { 'id': 'path', + 'json_api_color_palette_patch_document': 'body', 'filter': 'query', }, 'collection_format_map': { @@ -4264,26 +3952,31 @@ def __init__(self, api_client=None): 'application/json', 'application/vnd.gooddata.api+json' ], - 'content_type': [], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] }, api_client=api_client ) - self.get_entity_organization_settings_endpoint = _Endpoint( + self.patch_entity_csp_directives_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiOrganizationSettingOutDocument,), + 'response_type': (JsonApiCspDirectiveOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/organizationSettings/{id}', - 'operation_id': 'get_entity_organization_settings', - 'http_method': 'GET', + 'endpoint_path': '/api/v1/entities/cspDirectives/{id}', + 'operation_id': 'patch_entity_csp_directives', + 'http_method': 'PATCH', 'servers': None, }, params_map={ 'all': [ 'id', + 'json_api_csp_directive_patch_document', 'filter', ], 'required': [ 'id', + 'json_api_csp_directive_patch_document', ], 'nullable': [ ], @@ -4307,6 +4000,8 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), + 'json_api_csp_directive_patch_document': + (JsonApiCspDirectivePatchDocument,), 'filter': (str,), }, @@ -4316,6 +4011,7 @@ def __init__(self, api_client=None): }, 'location_map': { 'id': 'path', + 'json_api_csp_directive_patch_document': 'body', 'filter': 'query', }, 'collection_format_map': { @@ -4326,26 +4022,31 @@ def __init__(self, api_client=None): 'application/json', 'application/vnd.gooddata.api+json' ], - 'content_type': [], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] }, api_client=api_client ) - self.get_entity_themes_endpoint = _Endpoint( + self.patch_entity_export_templates_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiThemeOutDocument,), + 'response_type': (JsonApiExportTemplateOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/themes/{id}', - 'operation_id': 'get_entity_themes', - 'http_method': 'GET', + 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', + 'operation_id': 'patch_entity_export_templates', + 'http_method': 'PATCH', 'servers': None, }, params_map={ 'all': [ 'id', + 'json_api_export_template_patch_document', 'filter', ], 'required': [ 'id', + 'json_api_export_template_patch_document', ], 'nullable': [ ], @@ -4369,6 +4070,8 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), + 'json_api_export_template_patch_document': + (JsonApiExportTemplatePatchDocument,), 'filter': (str,), }, @@ -4378,6 +4081,7 @@ def __init__(self, api_client=None): }, 'location_map': { 'id': 'path', + 'json_api_export_template_patch_document': 'body', 'filter': 'query', }, 'collection_format_map': { @@ -4388,32 +4092,35 @@ def __init__(self, api_client=None): 'application/json', 'application/vnd.gooddata.api+json' ], - 'content_type': [], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] }, api_client=api_client ) - self.get_entity_user_groups_endpoint = _Endpoint( + self.patch_entity_identity_providers_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiUserGroupOutDocument,), + 'response_type': (JsonApiIdentityProviderOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/userGroups/{id}', - 'operation_id': 'get_entity_user_groups', - 'http_method': 'GET', + 'endpoint_path': '/api/v1/entities/identityProviders/{id}', + 'operation_id': 'patch_entity_identity_providers', + 'http_method': 'PATCH', 'servers': None, }, params_map={ 'all': [ 'id', + 'json_api_identity_provider_patch_document', 'filter', - 'include', ], 'required': [ 'id', + 'json_api_identity_provider_patch_document', ], 'nullable': [ ], 'enum': [ - 'include', ], 'validation': [ 'id', @@ -4429,33 +4136,25 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "PARENTS": "parents", - "ALL": "ALL" - }, }, 'openapi_types': { 'id': (str,), + 'json_api_identity_provider_patch_document': + (JsonApiIdentityProviderPatchDocument,), 'filter': (str,), - 'include': - ([str],), }, 'attribute_map': { 'id': 'id', 'filter': 'filter', - 'include': 'include', }, 'location_map': { 'id': 'path', + 'json_api_identity_provider_patch_document': 'body', 'filter': 'query', - 'include': 'query', }, 'collection_format_map': { - 'include': 'csv', } }, headers_map={ @@ -4463,26 +4162,31 @@ def __init__(self, api_client=None): 'application/json', 'application/vnd.gooddata.api+json' ], - 'content_type': [], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] }, api_client=api_client ) - self.get_entity_user_identifiers_endpoint = _Endpoint( + self.patch_entity_llm_endpoints_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiUserIdentifierOutDocument,), + 'response_type': (JsonApiLlmEndpointOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/userIdentifiers/{id}', - 'operation_id': 'get_entity_user_identifiers', - 'http_method': 'GET', + 'endpoint_path': '/api/v1/entities/llmEndpoints/{id}', + 'operation_id': 'patch_entity_llm_endpoints', + 'http_method': 'PATCH', 'servers': None, }, params_map={ 'all': [ 'id', + 'json_api_llm_endpoint_patch_document', 'filter', ], 'required': [ 'id', + 'json_api_llm_endpoint_patch_document', ], 'nullable': [ ], @@ -4506,6 +4210,8 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), + 'json_api_llm_endpoint_patch_document': + (JsonApiLlmEndpointPatchDocument,), 'filter': (str,), }, @@ -4515,6 +4221,7 @@ def __init__(self, api_client=None): }, 'location_map': { 'id': 'path', + 'json_api_llm_endpoint_patch_document': 'body', 'filter': 'query', }, 'collection_format_map': { @@ -4525,32 +4232,35 @@ def __init__(self, api_client=None): 'application/json', 'application/vnd.gooddata.api+json' ], - 'content_type': [], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] }, api_client=api_client ) - self.get_entity_users_endpoint = _Endpoint( + self.patch_entity_llm_providers_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiUserOutDocument,), + 'response_type': (JsonApiLlmProviderOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{id}', - 'operation_id': 'get_entity_users', - 'http_method': 'GET', + 'endpoint_path': '/api/v1/entities/llmProviders/{id}', + 'operation_id': 'patch_entity_llm_providers', + 'http_method': 'PATCH', 'servers': None, }, params_map={ 'all': [ 'id', + 'json_api_llm_provider_patch_document', 'filter', - 'include', ], 'required': [ 'id', + 'json_api_llm_provider_patch_document', ], 'nullable': [ ], 'enum': [ - 'include', ], 'validation': [ 'id', @@ -4566,32 +4276,25 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "ALL": "ALL" - }, }, 'openapi_types': { 'id': (str,), + 'json_api_llm_provider_patch_document': + (JsonApiLlmProviderPatchDocument,), 'filter': (str,), - 'include': - ([str],), }, 'attribute_map': { 'id': 'id', 'filter': 'filter', - 'include': 'include', }, 'location_map': { 'id': 'path', + 'json_api_llm_provider_patch_document': 'body', 'filter': 'query', - 'include': 'query', }, 'collection_format_map': { - 'include': 'csv', } }, headers_map={ @@ -4599,38 +4302,38 @@ def __init__(self, api_client=None): 'application/json', 'application/vnd.gooddata.api+json' ], - 'content_type': [], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] }, api_client=api_client ) - self.get_entity_workspaces_endpoint = _Endpoint( + self.patch_entity_notification_channels_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiWorkspaceOutDocument,), + 'response_type': (JsonApiNotificationChannelOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{id}', - 'operation_id': 'get_entity_workspaces', - 'http_method': 'GET', + 'endpoint_path': '/api/v1/entities/notificationChannels/{id}', + 'operation_id': 'patch_entity_notification_channels', + 'http_method': 'PATCH', 'servers': None, }, params_map={ 'all': [ 'id', + 'json_api_notification_channel_patch_document', 'filter', - 'include', - 'meta_include', ], 'required': [ 'id', + 'json_api_notification_channel_patch_document', ], 'nullable': [ ], 'enum': [ - 'include', - 'meta_include', ], 'validation': [ 'id', - 'meta_include', ] }, root_map={ @@ -4641,52 +4344,27 @@ def __init__(self, api_client=None): 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 }, }, - ('meta_include',): { - - }, }, 'allowed_values': { - ('include',): { - - "WORKSPACES": "workspaces", - "PARENT": "parent", - "ALL": "ALL" - }, - ('meta_include',): { - - "CONFIG": "config", - "PERMISSIONS": "permissions", - "HIERARCHY": "hierarchy", - "DATAMODELDATASETS": "dataModelDatasets", - "ALL": "all", - "ALL": "ALL" - }, }, 'openapi_types': { 'id': (str,), + 'json_api_notification_channel_patch_document': + (JsonApiNotificationChannelPatchDocument,), 'filter': (str,), - 'include': - ([str],), - 'meta_include': - ([str],), }, 'attribute_map': { 'id': 'id', 'filter': 'filter', - 'include': 'include', - 'meta_include': 'metaInclude', }, 'location_map': { 'id': 'path', + 'json_api_notification_channel_patch_document': 'body', 'filter': 'query', - 'include': 'query', - 'meta_include': 'query', }, 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', } }, headers_map={ @@ -4694,28 +4372,31 @@ def __init__(self, api_client=None): 'application/json', 'application/vnd.gooddata.api+json' ], - 'content_type': [], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] }, api_client=api_client ) - self.patch_entity_color_palettes_endpoint = _Endpoint( + self.patch_entity_organization_settings_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiColorPaletteOutDocument,), + 'response_type': (JsonApiOrganizationSettingOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/colorPalettes/{id}', - 'operation_id': 'patch_entity_color_palettes', + 'endpoint_path': '/api/v1/entities/organizationSettings/{id}', + 'operation_id': 'patch_entity_organization_settings', 'http_method': 'PATCH', 'servers': None, }, params_map={ 'all': [ 'id', - 'json_api_color_palette_patch_document', + 'json_api_organization_setting_patch_document', 'filter', ], 'required': [ 'id', - 'json_api_color_palette_patch_document', + 'json_api_organization_setting_patch_document', ], 'nullable': [ ], @@ -4739,8 +4420,8 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), - 'json_api_color_palette_patch_document': - (JsonApiColorPalettePatchDocument,), + 'json_api_organization_setting_patch_document': + (JsonApiOrganizationSettingPatchDocument,), 'filter': (str,), }, @@ -4750,7 +4431,7 @@ def __init__(self, api_client=None): }, 'location_map': { 'id': 'path', - 'json_api_color_palette_patch_document': 'body', + 'json_api_organization_setting_patch_document': 'body', 'filter': 'query', }, 'collection_format_map': { @@ -4768,24 +4449,24 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.patch_entity_csp_directives_endpoint = _Endpoint( + self.patch_entity_themes_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiCspDirectiveOutDocument,), + 'response_type': (JsonApiThemeOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/cspDirectives/{id}', - 'operation_id': 'patch_entity_csp_directives', + 'endpoint_path': '/api/v1/entities/themes/{id}', + 'operation_id': 'patch_entity_themes', 'http_method': 'PATCH', 'servers': None, }, params_map={ 'all': [ 'id', - 'json_api_csp_directive_patch_document', + 'json_api_theme_patch_document', 'filter', ], 'required': [ 'id', - 'json_api_csp_directive_patch_document', + 'json_api_theme_patch_document', ], 'nullable': [ ], @@ -4809,8 +4490,8 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), - 'json_api_csp_directive_patch_document': - (JsonApiCspDirectivePatchDocument,), + 'json_api_theme_patch_document': + (JsonApiThemePatchDocument,), 'filter': (str,), }, @@ -4820,7 +4501,7 @@ def __init__(self, api_client=None): }, 'location_map': { 'id': 'path', - 'json_api_csp_directive_patch_document': 'body', + 'json_api_theme_patch_document': 'body', 'filter': 'query', }, 'collection_format_map': { @@ -4838,28 +4519,30 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.patch_entity_custom_geo_collections_endpoint = _Endpoint( + self.patch_entity_user_groups_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiCustomGeoCollectionOutDocument,), + 'response_type': (JsonApiUserGroupOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/customGeoCollections/{id}', - 'operation_id': 'patch_entity_custom_geo_collections', + 'endpoint_path': '/api/v1/entities/userGroups/{id}', + 'operation_id': 'patch_entity_user_groups', 'http_method': 'PATCH', 'servers': None, }, params_map={ 'all': [ 'id', - 'json_api_custom_geo_collection_patch_document', + 'json_api_user_group_patch_document', 'filter', + 'include', ], 'required': [ 'id', - 'json_api_custom_geo_collection_patch_document', + 'json_api_user_group_patch_document', ], 'nullable': [ ], 'enum': [ + 'include', ], 'validation': [ 'id', @@ -4875,25 +4558,36 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { + ('include',): { + + "USERGROUPS": "userGroups", + "PARENTS": "parents", + "ALL": "ALL" + }, }, 'openapi_types': { 'id': (str,), - 'json_api_custom_geo_collection_patch_document': - (JsonApiCustomGeoCollectionPatchDocument,), + 'json_api_user_group_patch_document': + (JsonApiUserGroupPatchDocument,), 'filter': (str,), + 'include': + ([str],), }, 'attribute_map': { 'id': 'id', 'filter': 'filter', + 'include': 'include', }, 'location_map': { 'id': 'path', - 'json_api_custom_geo_collection_patch_document': 'body', + 'json_api_user_group_patch_document': 'body', 'filter': 'query', + 'include': 'query', }, 'collection_format_map': { + 'include': 'csv', } }, headers_map={ @@ -4908,28 +4602,30 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.patch_entity_data_sources_endpoint = _Endpoint( + self.patch_entity_users_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiDataSourceOutDocument,), + 'response_type': (JsonApiUserOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/dataSources/{id}', - 'operation_id': 'patch_entity_data_sources', + 'endpoint_path': '/api/v1/entities/users/{id}', + 'operation_id': 'patch_entity_users', 'http_method': 'PATCH', 'servers': None, }, params_map={ 'all': [ 'id', - 'json_api_data_source_patch_document', + 'json_api_user_patch_document', 'filter', + 'include', ], 'required': [ 'id', - 'json_api_data_source_patch_document', + 'json_api_user_patch_document', ], 'nullable': [ ], 'enum': [ + 'include', ], 'validation': [ 'id', @@ -4945,25 +4641,35 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { + ('include',): { + + "USERGROUPS": "userGroups", + "ALL": "ALL" + }, }, 'openapi_types': { 'id': (str,), - 'json_api_data_source_patch_document': - (JsonApiDataSourcePatchDocument,), + 'json_api_user_patch_document': + (JsonApiUserPatchDocument,), 'filter': (str,), + 'include': + ([str],), }, 'attribute_map': { 'id': 'id', 'filter': 'filter', + 'include': 'include', }, 'location_map': { 'id': 'path', - 'json_api_data_source_patch_document': 'body', + 'json_api_user_patch_document': 'body', 'filter': 'query', + 'include': 'query', }, 'collection_format_map': { + 'include': 'csv', } }, headers_map={ @@ -4978,28 +4684,30 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.patch_entity_export_templates_endpoint = _Endpoint( + self.patch_entity_workspaces_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiExportTemplateOutDocument,), + 'response_type': (JsonApiWorkspaceOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', - 'operation_id': 'patch_entity_export_templates', + 'endpoint_path': '/api/v1/entities/workspaces/{id}', + 'operation_id': 'patch_entity_workspaces', 'http_method': 'PATCH', 'servers': None, }, params_map={ 'all': [ 'id', - 'json_api_export_template_patch_document', + 'json_api_workspace_patch_document', 'filter', + 'include', ], 'required': [ 'id', - 'json_api_export_template_patch_document', + 'json_api_workspace_patch_document', ], 'nullable': [ ], 'enum': [ + 'include', ], 'validation': [ 'id', @@ -5015,25 +4723,36 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { + ('include',): { + + "WORKSPACES": "workspaces", + "PARENT": "parent", + "ALL": "ALL" + }, }, 'openapi_types': { 'id': (str,), - 'json_api_export_template_patch_document': - (JsonApiExportTemplatePatchDocument,), + 'json_api_workspace_patch_document': + (JsonApiWorkspacePatchDocument,), 'filter': (str,), + 'include': + ([str],), }, 'attribute_map': { 'id': 'id', 'filter': 'filter', + 'include': 'include', }, 'location_map': { 'id': 'path', - 'json_api_export_template_patch_document': 'body', + 'json_api_workspace_patch_document': 'body', 'filter': 'query', + 'include': 'query', }, 'collection_format_map': { + 'include': 'csv', } }, headers_map={ @@ -5048,24 +4767,24 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.patch_entity_identity_providers_endpoint = _Endpoint( + self.update_entity_color_palettes_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiIdentityProviderOutDocument,), + 'response_type': (JsonApiColorPaletteOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/identityProviders/{id}', - 'operation_id': 'patch_entity_identity_providers', - 'http_method': 'PATCH', + 'endpoint_path': '/api/v1/entities/colorPalettes/{id}', + 'operation_id': 'update_entity_color_palettes', + 'http_method': 'PUT', 'servers': None, }, params_map={ 'all': [ 'id', - 'json_api_identity_provider_patch_document', + 'json_api_color_palette_in_document', 'filter', ], 'required': [ 'id', - 'json_api_identity_provider_patch_document', + 'json_api_color_palette_in_document', ], 'nullable': [ ], @@ -5089,8 +4808,8 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), - 'json_api_identity_provider_patch_document': - (JsonApiIdentityProviderPatchDocument,), + 'json_api_color_palette_in_document': + (JsonApiColorPaletteInDocument,), 'filter': (str,), }, @@ -5100,7 +4819,7 @@ def __init__(self, api_client=None): }, 'location_map': { 'id': 'path', - 'json_api_identity_provider_patch_document': 'body', + 'json_api_color_palette_in_document': 'body', 'filter': 'query', }, 'collection_format_map': { @@ -5118,24 +4837,24 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.patch_entity_jwks_endpoint = _Endpoint( + self.update_entity_csp_directives_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiJwkOutDocument,), + 'response_type': (JsonApiCspDirectiveOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/jwks/{id}', - 'operation_id': 'patch_entity_jwks', - 'http_method': 'PATCH', - 'servers': None, - }, + 'endpoint_path': '/api/v1/entities/cspDirectives/{id}', + 'operation_id': 'update_entity_csp_directives', + 'http_method': 'PUT', + 'servers': None, + }, params_map={ 'all': [ 'id', - 'json_api_jwk_patch_document', + 'json_api_csp_directive_in_document', 'filter', ], 'required': [ 'id', - 'json_api_jwk_patch_document', + 'json_api_csp_directive_in_document', ], 'nullable': [ ], @@ -5159,8 +4878,8 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), - 'json_api_jwk_patch_document': - (JsonApiJwkPatchDocument,), + 'json_api_csp_directive_in_document': + (JsonApiCspDirectiveInDocument,), 'filter': (str,), }, @@ -5170,7 +4889,7 @@ def __init__(self, api_client=None): }, 'location_map': { 'id': 'path', - 'json_api_jwk_patch_document': 'body', + 'json_api_csp_directive_in_document': 'body', 'filter': 'query', }, 'collection_format_map': { @@ -5188,24 +4907,24 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.patch_entity_llm_endpoints_endpoint = _Endpoint( + self.update_entity_export_templates_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiLlmEndpointOutDocument,), + 'response_type': (JsonApiExportTemplateOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/llmEndpoints/{id}', - 'operation_id': 'patch_entity_llm_endpoints', - 'http_method': 'PATCH', + 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', + 'operation_id': 'update_entity_export_templates', + 'http_method': 'PUT', 'servers': None, }, params_map={ 'all': [ 'id', - 'json_api_llm_endpoint_patch_document', + 'json_api_export_template_in_document', 'filter', ], 'required': [ 'id', - 'json_api_llm_endpoint_patch_document', + 'json_api_export_template_in_document', ], 'nullable': [ ], @@ -5229,8 +4948,8 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), - 'json_api_llm_endpoint_patch_document': - (JsonApiLlmEndpointPatchDocument,), + 'json_api_export_template_in_document': + (JsonApiExportTemplateInDocument,), 'filter': (str,), }, @@ -5240,7 +4959,7 @@ def __init__(self, api_client=None): }, 'location_map': { 'id': 'path', - 'json_api_llm_endpoint_patch_document': 'body', + 'json_api_export_template_in_document': 'body', 'filter': 'query', }, 'collection_format_map': { @@ -5258,24 +4977,24 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.patch_entity_llm_providers_endpoint = _Endpoint( + self.update_entity_identity_providers_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiLlmProviderOutDocument,), + 'response_type': (JsonApiIdentityProviderOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/llmProviders/{id}', - 'operation_id': 'patch_entity_llm_providers', - 'http_method': 'PATCH', + 'endpoint_path': '/api/v1/entities/identityProviders/{id}', + 'operation_id': 'update_entity_identity_providers', + 'http_method': 'PUT', 'servers': None, }, params_map={ 'all': [ 'id', - 'json_api_llm_provider_patch_document', + 'json_api_identity_provider_in_document', 'filter', ], 'required': [ 'id', - 'json_api_llm_provider_patch_document', + 'json_api_identity_provider_in_document', ], 'nullable': [ ], @@ -5299,8 +5018,8 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), - 'json_api_llm_provider_patch_document': - (JsonApiLlmProviderPatchDocument,), + 'json_api_identity_provider_in_document': + (JsonApiIdentityProviderInDocument,), 'filter': (str,), }, @@ -5310,7 +5029,7 @@ def __init__(self, api_client=None): }, 'location_map': { 'id': 'path', - 'json_api_llm_provider_patch_document': 'body', + 'json_api_identity_provider_in_document': 'body', 'filter': 'query', }, 'collection_format_map': { @@ -5328,24 +5047,24 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.patch_entity_notification_channels_endpoint = _Endpoint( + self.update_entity_llm_endpoints_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiNotificationChannelOutDocument,), + 'response_type': (JsonApiLlmEndpointOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/notificationChannels/{id}', - 'operation_id': 'patch_entity_notification_channels', - 'http_method': 'PATCH', + 'endpoint_path': '/api/v1/entities/llmEndpoints/{id}', + 'operation_id': 'update_entity_llm_endpoints', + 'http_method': 'PUT', 'servers': None, }, params_map={ 'all': [ 'id', - 'json_api_notification_channel_patch_document', + 'json_api_llm_endpoint_in_document', 'filter', ], 'required': [ 'id', - 'json_api_notification_channel_patch_document', + 'json_api_llm_endpoint_in_document', ], 'nullable': [ ], @@ -5369,8 +5088,8 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), - 'json_api_notification_channel_patch_document': - (JsonApiNotificationChannelPatchDocument,), + 'json_api_llm_endpoint_in_document': + (JsonApiLlmEndpointInDocument,), 'filter': (str,), }, @@ -5380,7 +5099,7 @@ def __init__(self, api_client=None): }, 'location_map': { 'id': 'path', - 'json_api_notification_channel_patch_document': 'body', + 'json_api_llm_endpoint_in_document': 'body', 'filter': 'query', }, 'collection_format_map': { @@ -5398,24 +5117,24 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.patch_entity_organization_settings_endpoint = _Endpoint( + self.update_entity_llm_providers_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiOrganizationSettingOutDocument,), + 'response_type': (JsonApiLlmProviderOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/organizationSettings/{id}', - 'operation_id': 'patch_entity_organization_settings', - 'http_method': 'PATCH', + 'endpoint_path': '/api/v1/entities/llmProviders/{id}', + 'operation_id': 'update_entity_llm_providers', + 'http_method': 'PUT', 'servers': None, }, params_map={ 'all': [ 'id', - 'json_api_organization_setting_patch_document', + 'json_api_llm_provider_in_document', 'filter', ], 'required': [ 'id', - 'json_api_organization_setting_patch_document', + 'json_api_llm_provider_in_document', ], 'nullable': [ ], @@ -5439,8 +5158,8 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), - 'json_api_organization_setting_patch_document': - (JsonApiOrganizationSettingPatchDocument,), + 'json_api_llm_provider_in_document': + (JsonApiLlmProviderInDocument,), 'filter': (str,), }, @@ -5450,7 +5169,7 @@ def __init__(self, api_client=None): }, 'location_map': { 'id': 'path', - 'json_api_organization_setting_patch_document': 'body', + 'json_api_llm_provider_in_document': 'body', 'filter': 'query', }, 'collection_format_map': { @@ -5468,24 +5187,24 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.patch_entity_themes_endpoint = _Endpoint( + self.update_entity_notification_channels_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiThemeOutDocument,), + 'response_type': (JsonApiNotificationChannelOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/themes/{id}', - 'operation_id': 'patch_entity_themes', - 'http_method': 'PATCH', + 'endpoint_path': '/api/v1/entities/notificationChannels/{id}', + 'operation_id': 'update_entity_notification_channels', + 'http_method': 'PUT', 'servers': None, }, params_map={ 'all': [ 'id', - 'json_api_theme_patch_document', + 'json_api_notification_channel_in_document', 'filter', ], 'required': [ 'id', - 'json_api_theme_patch_document', + 'json_api_notification_channel_in_document', ], 'nullable': [ ], @@ -5509,8 +5228,8 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), - 'json_api_theme_patch_document': - (JsonApiThemePatchDocument,), + 'json_api_notification_channel_in_document': + (JsonApiNotificationChannelInDocument,), 'filter': (str,), }, @@ -5520,7 +5239,7 @@ def __init__(self, api_client=None): }, 'location_map': { 'id': 'path', - 'json_api_theme_patch_document': 'body', + 'json_api_notification_channel_in_document': 'body', 'filter': 'query', }, 'collection_format_map': { @@ -5538,30 +5257,28 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.patch_entity_user_groups_endpoint = _Endpoint( + self.update_entity_organization_settings_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiUserGroupOutDocument,), + 'response_type': (JsonApiOrganizationSettingOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/userGroups/{id}', - 'operation_id': 'patch_entity_user_groups', - 'http_method': 'PATCH', + 'endpoint_path': '/api/v1/entities/organizationSettings/{id}', + 'operation_id': 'update_entity_organization_settings', + 'http_method': 'PUT', 'servers': None, }, params_map={ 'all': [ 'id', - 'json_api_user_group_patch_document', + 'json_api_organization_setting_in_document', 'filter', - 'include', ], 'required': [ 'id', - 'json_api_user_group_patch_document', + 'json_api_organization_setting_in_document', ], 'nullable': [ ], 'enum': [ - 'include', ], 'validation': [ 'id', @@ -5577,36 +5294,25 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "PARENTS": "parents", - "ALL": "ALL" - }, }, 'openapi_types': { 'id': (str,), - 'json_api_user_group_patch_document': - (JsonApiUserGroupPatchDocument,), + 'json_api_organization_setting_in_document': + (JsonApiOrganizationSettingInDocument,), 'filter': (str,), - 'include': - ([str],), }, 'attribute_map': { 'id': 'id', 'filter': 'filter', - 'include': 'include', }, 'location_map': { 'id': 'path', - 'json_api_user_group_patch_document': 'body', + 'json_api_organization_setting_in_document': 'body', 'filter': 'query', - 'include': 'query', }, 'collection_format_map': { - 'include': 'csv', } }, headers_map={ @@ -5621,30 +5327,28 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.patch_entity_users_endpoint = _Endpoint( + self.update_entity_themes_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiUserOutDocument,), + 'response_type': (JsonApiThemeOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{id}', - 'operation_id': 'patch_entity_users', - 'http_method': 'PATCH', + 'endpoint_path': '/api/v1/entities/themes/{id}', + 'operation_id': 'update_entity_themes', + 'http_method': 'PUT', 'servers': None, }, params_map={ 'all': [ 'id', - 'json_api_user_patch_document', + 'json_api_theme_in_document', 'filter', - 'include', ], 'required': [ 'id', - 'json_api_user_patch_document', + 'json_api_theme_in_document', ], 'nullable': [ ], 'enum': [ - 'include', ], 'validation': [ 'id', @@ -5660,35 +5364,25 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "ALL": "ALL" - }, }, 'openapi_types': { 'id': (str,), - 'json_api_user_patch_document': - (JsonApiUserPatchDocument,), + 'json_api_theme_in_document': + (JsonApiThemeInDocument,), 'filter': (str,), - 'include': - ([str],), }, 'attribute_map': { 'id': 'id', 'filter': 'filter', - 'include': 'include', }, 'location_map': { 'id': 'path', - 'json_api_user_patch_document': 'body', + 'json_api_theme_in_document': 'body', 'filter': 'query', - 'include': 'query', }, 'collection_format_map': { - 'include': 'csv', } }, headers_map={ @@ -5703,25 +5397,25 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.patch_entity_workspaces_endpoint = _Endpoint( + self.update_entity_user_groups_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiWorkspaceOutDocument,), + 'response_type': (JsonApiUserGroupOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{id}', - 'operation_id': 'patch_entity_workspaces', - 'http_method': 'PATCH', + 'endpoint_path': '/api/v1/entities/userGroups/{id}', + 'operation_id': 'update_entity_user_groups', + 'http_method': 'PUT', 'servers': None, }, params_map={ 'all': [ 'id', - 'json_api_workspace_patch_document', + 'json_api_user_group_in_document', 'filter', 'include', ], 'required': [ 'id', - 'json_api_workspace_patch_document', + 'json_api_user_group_in_document', ], 'nullable': [ ], @@ -5744,16 +5438,16 @@ def __init__(self, api_client=None): 'allowed_values': { ('include',): { - "WORKSPACES": "workspaces", - "PARENT": "parent", + "USERGROUPS": "userGroups", + "PARENTS": "parents", "ALL": "ALL" }, }, 'openapi_types': { 'id': (str,), - 'json_api_workspace_patch_document': - (JsonApiWorkspacePatchDocument,), + 'json_api_user_group_in_document': + (JsonApiUserGroupInDocument,), 'filter': (str,), 'include': @@ -5766,7 +5460,7 @@ def __init__(self, api_client=None): }, 'location_map': { 'id': 'path', - 'json_api_workspace_patch_document': 'body', + 'json_api_user_group_in_document': 'body', 'filter': 'query', 'include': 'query', }, @@ -5786,28 +5480,30 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.update_entity_color_palettes_endpoint = _Endpoint( + self.update_entity_users_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiColorPaletteOutDocument,), + 'response_type': (JsonApiUserOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/colorPalettes/{id}', - 'operation_id': 'update_entity_color_palettes', + 'endpoint_path': '/api/v1/entities/users/{id}', + 'operation_id': 'update_entity_users', 'http_method': 'PUT', 'servers': None, }, params_map={ 'all': [ 'id', - 'json_api_color_palette_in_document', + 'json_api_user_in_document', 'filter', + 'include', ], 'required': [ 'id', - 'json_api_color_palette_in_document', + 'json_api_user_in_document', ], 'nullable': [ ], 'enum': [ + 'include', ], 'validation': [ 'id', @@ -5823,2318 +5519,150 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { + ('include',): { + + "USERGROUPS": "userGroups", + "ALL": "ALL" + }, }, 'openapi_types': { 'id': (str,), - 'json_api_color_palette_in_document': - (JsonApiColorPaletteInDocument,), + 'json_api_user_in_document': + (JsonApiUserInDocument,), 'filter': (str,), + 'include': + ([str],), }, 'attribute_map': { 'id': 'id', 'filter': 'filter', + 'include': 'include', }, 'location_map': { 'id': 'path', - 'json_api_color_palette_in_document': 'body', + 'json_api_user_in_document': 'body', 'filter': 'query', + 'include': 'query', }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_csp_directives_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCspDirectiveOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/cspDirectives/{id}', - 'operation_id': 'update_entity_csp_directives', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_csp_directive_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_csp_directive_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_csp_directive_in_document': - (JsonApiCspDirectiveInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_csp_directive_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_custom_geo_collections_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCustomGeoCollectionOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/customGeoCollections/{id}', - 'operation_id': 'update_entity_custom_geo_collections', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_custom_geo_collection_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_custom_geo_collection_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_custom_geo_collection_in_document': - (JsonApiCustomGeoCollectionInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_custom_geo_collection_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_data_sources_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDataSourceOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/dataSources/{id}', - 'operation_id': 'update_entity_data_sources', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_data_source_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_data_source_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_data_source_in_document': - (JsonApiDataSourceInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_data_source_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_export_templates_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportTemplateOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', - 'operation_id': 'update_entity_export_templates', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_export_template_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_export_template_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_export_template_in_document': - (JsonApiExportTemplateInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_export_template_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_identity_providers_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiIdentityProviderOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/identityProviders/{id}', - 'operation_id': 'update_entity_identity_providers', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_identity_provider_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_identity_provider_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_identity_provider_in_document': - (JsonApiIdentityProviderInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_identity_provider_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_jwks_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiJwkOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/jwks/{id}', - 'operation_id': 'update_entity_jwks', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_jwk_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_jwk_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_jwk_in_document': - (JsonApiJwkInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_jwk_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_llm_endpoints_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiLlmEndpointOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/llmEndpoints/{id}', - 'operation_id': 'update_entity_llm_endpoints', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_llm_endpoint_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_llm_endpoint_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_llm_endpoint_in_document': - (JsonApiLlmEndpointInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_llm_endpoint_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_llm_providers_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiLlmProviderOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/llmProviders/{id}', - 'operation_id': 'update_entity_llm_providers', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_llm_provider_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_llm_provider_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_llm_provider_in_document': - (JsonApiLlmProviderInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_llm_provider_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_notification_channels_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiNotificationChannelOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/notificationChannels/{id}', - 'operation_id': 'update_entity_notification_channels', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_notification_channel_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_notification_channel_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_notification_channel_in_document': - (JsonApiNotificationChannelInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_notification_channel_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_organization_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiOrganizationSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/organizationSettings/{id}', - 'operation_id': 'update_entity_organization_settings', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_organization_setting_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_organization_setting_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_organization_setting_in_document': - (JsonApiOrganizationSettingInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_organization_setting_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_themes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiThemeOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/themes/{id}', - 'operation_id': 'update_entity_themes', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_theme_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_theme_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_theme_in_document': - (JsonApiThemeInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_theme_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_user_groups_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserGroupOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/userGroups/{id}', - 'operation_id': 'update_entity_user_groups', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_user_group_in_document', - 'filter', - 'include', - ], - 'required': [ - 'id', - 'json_api_user_group_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "PARENTS": "parents", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_user_group_in_document': - (JsonApiUserGroupInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'id': 'path', - 'json_api_user_group_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_users_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{id}', - 'operation_id': 'update_entity_users', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_user_in_document', - 'filter', - 'include', - ], - 'required': [ - 'id', - 'json_api_user_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_user_in_document': - (JsonApiUserInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'id': 'path', - 'json_api_user_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_workspaces_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{id}', - 'operation_id': 'update_entity_workspaces', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_workspace_in_document', - 'filter', - 'include', - ], - 'required': [ - 'id', - 'json_api_workspace_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - ('include',): { - - "WORKSPACES": "workspaces", - "PARENT": "parent", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_workspace_in_document': - (JsonApiWorkspaceInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'id': 'path', - 'json_api_workspace_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - - def create_entity_color_palettes( - self, - json_api_color_palette_in_document, - **kwargs - ): - """Post Color Pallettes # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_color_palettes(json_api_color_palette_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_color_palette_in_document (JsonApiColorPaletteInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiColorPaletteOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_color_palette_in_document'] = \ - json_api_color_palette_in_document - return self.create_entity_color_palettes_endpoint.call_with_http_info(**kwargs) - - def create_entity_csp_directives( - self, - json_api_csp_directive_in_document, - **kwargs - ): - """Post CSP Directives # noqa: E501 - - Context Security Police Directive # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_csp_directives(json_api_csp_directive_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_csp_directive_in_document (JsonApiCspDirectiveInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCspDirectiveOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_csp_directive_in_document'] = \ - json_api_csp_directive_in_document - return self.create_entity_csp_directives_endpoint.call_with_http_info(**kwargs) - - def create_entity_custom_geo_collections( - self, - json_api_custom_geo_collection_in_document, - **kwargs - ): - """create_entity_custom_geo_collections # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_custom_geo_collections(json_api_custom_geo_collection_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_custom_geo_collection_in_document (JsonApiCustomGeoCollectionInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCustomGeoCollectionOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_custom_geo_collection_in_document'] = \ - json_api_custom_geo_collection_in_document - return self.create_entity_custom_geo_collections_endpoint.call_with_http_info(**kwargs) - - def create_entity_data_sources( - self, - json_api_data_source_in_document, - **kwargs - ): - """Post Data Sources # noqa: E501 - - Data Source - represents data source for the workspace # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_data_sources(json_api_data_source_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_data_source_in_document (JsonApiDataSourceInDocument): - - Keyword Args: - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDataSourceOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_data_source_in_document'] = \ - json_api_data_source_in_document - return self.create_entity_data_sources_endpoint.call_with_http_info(**kwargs) - - def create_entity_export_templates( - self, - json_api_export_template_post_optional_id_document, - **kwargs - ): - """Post Export Template entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_export_templates(json_api_export_template_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_export_template_post_optional_id_document (JsonApiExportTemplatePostOptionalIdDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportTemplateOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_export_template_post_optional_id_document'] = \ - json_api_export_template_post_optional_id_document - return self.create_entity_export_templates_endpoint.call_with_http_info(**kwargs) - - def create_entity_identity_providers( - self, - json_api_identity_provider_in_document, - **kwargs - ): - """Post Identity Providers # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_identity_providers(json_api_identity_provider_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_identity_provider_in_document (JsonApiIdentityProviderInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiIdentityProviderOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_identity_provider_in_document'] = \ - json_api_identity_provider_in_document - return self.create_entity_identity_providers_endpoint.call_with_http_info(**kwargs) - - def create_entity_jwks( - self, - json_api_jwk_in_document, - **kwargs - ): - """Post Jwks # noqa: E501 - - Creates JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_jwks(json_api_jwk_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_jwk_in_document (JsonApiJwkInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiJwkOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_jwk_in_document'] = \ - json_api_jwk_in_document - return self.create_entity_jwks_endpoint.call_with_http_info(**kwargs) - - def create_entity_llm_endpoints( - self, - json_api_llm_endpoint_in_document, - **kwargs - ): - """Post LLM endpoint entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_llm_endpoints(json_api_llm_endpoint_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_llm_endpoint_in_document (JsonApiLlmEndpointInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiLlmEndpointOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_llm_endpoint_in_document'] = \ - json_api_llm_endpoint_in_document - return self.create_entity_llm_endpoints_endpoint.call_with_http_info(**kwargs) - - def create_entity_llm_providers( - self, - json_api_llm_provider_in_document, - **kwargs - ): - """Post LLM Provider entities # noqa: E501 - - LLM Provider - connection configuration for LLM services # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_llm_providers(json_api_llm_provider_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_llm_provider_in_document (JsonApiLlmProviderInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiLlmProviderOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_llm_provider_in_document'] = \ - json_api_llm_provider_in_document - return self.create_entity_llm_providers_endpoint.call_with_http_info(**kwargs) - - def create_entity_notification_channels( - self, - json_api_notification_channel_post_optional_id_document, - **kwargs - ): - """Post Notification Channel entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_notification_channels(json_api_notification_channel_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_notification_channel_post_optional_id_document (JsonApiNotificationChannelPostOptionalIdDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiNotificationChannelOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_notification_channel_post_optional_id_document'] = \ - json_api_notification_channel_post_optional_id_document - return self.create_entity_notification_channels_endpoint.call_with_http_info(**kwargs) - - def create_entity_organization_settings( - self, - json_api_organization_setting_in_document, - **kwargs - ): - """Post Organization Setting entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_organization_settings(json_api_organization_setting_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_organization_setting_in_document (JsonApiOrganizationSettingInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiOrganizationSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_organization_setting_in_document'] = \ - json_api_organization_setting_in_document - return self.create_entity_organization_settings_endpoint.call_with_http_info(**kwargs) - - def create_entity_themes( - self, - json_api_theme_in_document, - **kwargs - ): - """Post Theming # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_themes(json_api_theme_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_theme_in_document (JsonApiThemeInDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiThemeOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_theme_in_document'] = \ - json_api_theme_in_document - return self.create_entity_themes_endpoint.call_with_http_info(**kwargs) - - def create_entity_user_groups( - self, - json_api_user_group_in_document, - **kwargs - ): - """Post User Group entities # noqa: E501 - - User Group - creates tree-like structure for categorizing users # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_user_groups(json_api_user_group_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_user_group_in_document (JsonApiUserGroupInDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserGroupOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_user_group_in_document'] = \ - json_api_user_group_in_document - return self.create_entity_user_groups_endpoint.call_with_http_info(**kwargs) - - def create_entity_users( - self, - json_api_user_in_document, - **kwargs - ): - """Post User entities # noqa: E501 - - User - represents entity interacting with platform # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_users(json_api_user_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_user_in_document (JsonApiUserInDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_user_in_document'] = \ - json_api_user_in_document - return self.create_entity_users_endpoint.call_with_http_info(**kwargs) - - def create_entity_workspaces( - self, - json_api_workspace_in_document, - **kwargs - ): - """Post Workspace entities # noqa: E501 - - Space of the shared interest # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_workspaces(json_api_workspace_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_workspace_in_document (JsonApiWorkspaceInDocument): + self.update_entity_workspaces_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{id}', + 'operation_id': 'update_entity_workspaces', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'json_api_workspace_in_document', + 'filter', + 'include', + ], + 'required': [ + 'id', + 'json_api_workspace_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('include',): { - Returns: - JsonApiWorkspaceOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + "WORKSPACES": "workspaces", + "PARENT": "parent", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'id': + (str,), + 'json_api_workspace_in_document': + (JsonApiWorkspaceInDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'id': 'path', + 'json_api_workspace_in_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_workspace_in_document'] = \ - json_api_workspace_in_document - return self.create_entity_workspaces_endpoint.call_with_http_info(**kwargs) - def delete_entity_color_palettes( + def create_entity_color_palettes( self, - id, + json_api_color_palette_in_document, **kwargs ): - """Delete a Color Pallette # noqa: E501 + """Post Color Pallettes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_color_palettes(id, async_req=True) + >>> thread = api.create_entity_color_palettes(json_api_color_palette_in_document, async_req=True) >>> result = thread.get() Args: - id (str): + json_api_color_palette_in_document (JsonApiColorPaletteInDocument): Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -8167,7 +5695,7 @@ def delete_entity_color_palettes( async_req (bool): execute request asynchronously Returns: - None + JsonApiColorPaletteOutDocument If the method is called asynchronously, returns the request thread. """ @@ -8196,29 +5724,28 @@ def delete_entity_color_palettes( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_color_palettes_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_color_palette_in_document'] = \ + json_api_color_palette_in_document + return self.create_entity_color_palettes_endpoint.call_with_http_info(**kwargs) - def delete_entity_csp_directives( + def create_entity_csp_directives( self, - id, + json_api_csp_directive_in_document, **kwargs ): - """Delete CSP Directives # noqa: E501 + """Post CSP Directives # noqa: E501 Context Security Police Directive # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_csp_directives(id, async_req=True) + >>> thread = api.create_entity_csp_directives(json_api_csp_directive_in_document, async_req=True) >>> result = thread.get() Args: - id (str): + json_api_csp_directive_in_document (JsonApiCspDirectiveInDocument): Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -8251,7 +5778,7 @@ def delete_entity_csp_directives( async_req (bool): execute request asynchronously Returns: - None + JsonApiCspDirectiveOutDocument If the method is called asynchronously, returns the request thread. """ @@ -8280,28 +5807,27 @@ def delete_entity_csp_directives( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_csp_directives_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_csp_directive_in_document'] = \ + json_api_csp_directive_in_document + return self.create_entity_csp_directives_endpoint.call_with_http_info(**kwargs) - def delete_entity_custom_geo_collections( + def create_entity_export_templates( self, - id, + json_api_export_template_post_optional_id_document, **kwargs ): - """delete_entity_custom_geo_collections # noqa: E501 + """Post Export Template entities # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_custom_geo_collections(id, async_req=True) + >>> thread = api.create_entity_export_templates(json_api_export_template_post_optional_id_document, async_req=True) >>> result = thread.get() Args: - id (str): + json_api_export_template_post_optional_id_document (JsonApiExportTemplatePostOptionalIdDocument): Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -8334,7 +5860,7 @@ def delete_entity_custom_geo_collections( async_req (bool): execute request asynchronously Returns: - None + JsonApiExportTemplateOutDocument If the method is called asynchronously, returns the request thread. """ @@ -8363,29 +5889,27 @@ def delete_entity_custom_geo_collections( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_custom_geo_collections_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_export_template_post_optional_id_document'] = \ + json_api_export_template_post_optional_id_document + return self.create_entity_export_templates_endpoint.call_with_http_info(**kwargs) - def delete_entity_data_sources( + def create_entity_identity_providers( self, - id, + json_api_identity_provider_in_document, **kwargs ): - """Delete Data Source entity # noqa: E501 + """Post Identity Providers # noqa: E501 - Data Source - represents data source for the workspace # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_data_sources(id, async_req=True) + >>> thread = api.create_entity_identity_providers(json_api_identity_provider_in_document, async_req=True) >>> result = thread.get() Args: - id (str): + json_api_identity_provider_in_document (JsonApiIdentityProviderInDocument): Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -8418,7 +5942,7 @@ def delete_entity_data_sources( async_req (bool): execute request asynchronously Returns: - None + JsonApiIdentityProviderOutDocument If the method is called asynchronously, returns the request thread. """ @@ -8447,28 +5971,27 @@ def delete_entity_data_sources( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_data_sources_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_identity_provider_in_document'] = \ + json_api_identity_provider_in_document + return self.create_entity_identity_providers_endpoint.call_with_http_info(**kwargs) - def delete_entity_export_templates( + def create_entity_llm_endpoints( self, - id, + json_api_llm_endpoint_in_document, **kwargs ): - """Delete Export Template entity # noqa: E501 + """Post LLM endpoint entities # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_export_templates(id, async_req=True) + >>> thread = api.create_entity_llm_endpoints(json_api_llm_endpoint_in_document, async_req=True) >>> result = thread.get() Args: - id (str): + json_api_llm_endpoint_in_document (JsonApiLlmEndpointInDocument): Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -8501,7 +6024,7 @@ def delete_entity_export_templates( async_req (bool): execute request asynchronously Returns: - None + JsonApiLlmEndpointOutDocument If the method is called asynchronously, returns the request thread. """ @@ -8530,28 +6053,28 @@ def delete_entity_export_templates( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_export_templates_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_llm_endpoint_in_document'] = \ + json_api_llm_endpoint_in_document + return self.create_entity_llm_endpoints_endpoint.call_with_http_info(**kwargs) - def delete_entity_identity_providers( + def create_entity_llm_providers( self, - id, + json_api_llm_provider_in_document, **kwargs ): - """Delete Identity Provider # noqa: E501 + """Post LLM Provider entities # noqa: E501 + LLM Provider - connection configuration for LLM services # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_identity_providers(id, async_req=True) + >>> thread = api.create_entity_llm_providers(json_api_llm_provider_in_document, async_req=True) >>> result = thread.get() Args: - id (str): + json_api_llm_provider_in_document (JsonApiLlmProviderInDocument): Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -8584,7 +6107,7 @@ def delete_entity_identity_providers( async_req (bool): execute request asynchronously Returns: - None + JsonApiLlmProviderOutDocument If the method is called asynchronously, returns the request thread. """ @@ -8613,29 +6136,27 @@ def delete_entity_identity_providers( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_identity_providers_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_llm_provider_in_document'] = \ + json_api_llm_provider_in_document + return self.create_entity_llm_providers_endpoint.call_with_http_info(**kwargs) - def delete_entity_jwks( + def create_entity_notification_channels( self, - id, + json_api_notification_channel_post_optional_id_document, **kwargs ): - """Delete Jwk # noqa: E501 + """Post Notification Channel entities # noqa: E501 - Deletes JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_jwks(id, async_req=True) + >>> thread = api.create_entity_notification_channels(json_api_notification_channel_post_optional_id_document, async_req=True) >>> result = thread.get() Args: - id (str): + json_api_notification_channel_post_optional_id_document (JsonApiNotificationChannelPostOptionalIdDocument): Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -8668,7 +6189,7 @@ def delete_entity_jwks( async_req (bool): execute request asynchronously Returns: - None + JsonApiNotificationChannelOutDocument If the method is called asynchronously, returns the request thread. """ @@ -8697,28 +6218,27 @@ def delete_entity_jwks( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_jwks_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_notification_channel_post_optional_id_document'] = \ + json_api_notification_channel_post_optional_id_document + return self.create_entity_notification_channels_endpoint.call_with_http_info(**kwargs) - def delete_entity_llm_endpoints( + def create_entity_organization_settings( self, - id, + json_api_organization_setting_in_document, **kwargs ): - """delete_entity_llm_endpoints # noqa: E501 + """Post Organization Setting entities # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_llm_endpoints(id, async_req=True) + >>> thread = api.create_entity_organization_settings(json_api_organization_setting_in_document, async_req=True) >>> result = thread.get() Args: - id (str): + json_api_organization_setting_in_document (JsonApiOrganizationSettingInDocument): Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -8751,7 +6271,7 @@ def delete_entity_llm_endpoints( async_req (bool): execute request asynchronously Returns: - None + JsonApiOrganizationSettingOutDocument If the method is called asynchronously, returns the request thread. """ @@ -8780,28 +6300,27 @@ def delete_entity_llm_endpoints( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_llm_endpoints_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_organization_setting_in_document'] = \ + json_api_organization_setting_in_document + return self.create_entity_organization_settings_endpoint.call_with_http_info(**kwargs) - def delete_entity_llm_providers( + def create_entity_themes( self, - id, + json_api_theme_in_document, **kwargs ): - """Delete LLM Provider entity # noqa: E501 + """Post Theming # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_llm_providers(id, async_req=True) + >>> thread = api.create_entity_themes(json_api_theme_in_document, async_req=True) >>> result = thread.get() Args: - id (str): + json_api_theme_in_document (JsonApiThemeInDocument): Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -8834,7 +6353,7 @@ def delete_entity_llm_providers( async_req (bool): execute request asynchronously Returns: - None + JsonApiThemeOutDocument If the method is called asynchronously, returns the request thread. """ @@ -8863,28 +6382,29 @@ def delete_entity_llm_providers( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_llm_providers_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_theme_in_document'] = \ + json_api_theme_in_document + return self.create_entity_themes_endpoint.call_with_http_info(**kwargs) - def delete_entity_notification_channels( + def create_entity_user_groups( self, - id, + json_api_user_group_in_document, **kwargs ): - """Delete Notification Channel entity # noqa: E501 + """Post User Group entities # noqa: E501 + User Group - creates tree-like structure for categorizing users # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_notification_channels(id, async_req=True) + >>> thread = api.create_entity_user_groups(json_api_user_group_in_document, async_req=True) >>> result = thread.get() Args: - id (str): + json_api_user_group_in_document (JsonApiUserGroupInDocument): Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -8917,7 +6437,7 @@ def delete_entity_notification_channels( async_req (bool): execute request asynchronously Returns: - None + JsonApiUserGroupOutDocument If the method is called asynchronously, returns the request thread. """ @@ -8946,28 +6466,29 @@ def delete_entity_notification_channels( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_notification_channels_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_user_group_in_document'] = \ + json_api_user_group_in_document + return self.create_entity_user_groups_endpoint.call_with_http_info(**kwargs) - def delete_entity_organization_settings( + def create_entity_users( self, - id, + json_api_user_in_document, **kwargs ): - """Delete Organization entity # noqa: E501 + """Post User entities # noqa: E501 + User - represents entity interacting with platform # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_organization_settings(id, async_req=True) + >>> thread = api.create_entity_users(json_api_user_in_document, async_req=True) >>> result = thread.get() Args: - id (str): + json_api_user_in_document (JsonApiUserInDocument): Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -9000,7 +6521,7 @@ def delete_entity_organization_settings( async_req (bool): execute request asynchronously Returns: - None + JsonApiUserOutDocument If the method is called asynchronously, returns the request thread. """ @@ -9029,28 +6550,30 @@ def delete_entity_organization_settings( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_organization_settings_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_user_in_document'] = \ + json_api_user_in_document + return self.create_entity_users_endpoint.call_with_http_info(**kwargs) - def delete_entity_themes( + def create_entity_workspaces( self, - id, + json_api_workspace_in_document, **kwargs ): - """Delete Theming # noqa: E501 + """Post Workspace entities # noqa: E501 + Space of the shared interest # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_themes(id, async_req=True) + >>> thread = api.create_entity_workspaces(json_api_workspace_in_document, async_req=True) >>> result = thread.get() Args: - id (str): + json_api_workspace_in_document (JsonApiWorkspaceInDocument): Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -9083,7 +6606,7 @@ def delete_entity_themes( async_req (bool): execute request asynchronously Returns: - None + JsonApiWorkspaceOutDocument If the method is called asynchronously, returns the request thread. """ @@ -9112,22 +6635,21 @@ def delete_entity_themes( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_themes_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_workspace_in_document'] = \ + json_api_workspace_in_document + return self.create_entity_workspaces_endpoint.call_with_http_info(**kwargs) - def delete_entity_user_groups( + def delete_entity_color_palettes( self, id, **kwargs ): - """Delete UserGroup entity # noqa: E501 + """Delete a Color Pallette # noqa: E501 - User Group - creates tree-like structure for categorizing users # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_user_groups(id, async_req=True) + >>> thread = api.delete_entity_color_palettes(id, async_req=True) >>> result = thread.get() Args: @@ -9198,20 +6720,20 @@ def delete_entity_user_groups( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.delete_entity_user_groups_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_color_palettes_endpoint.call_with_http_info(**kwargs) - def delete_entity_users( + def delete_entity_csp_directives( self, id, **kwargs ): - """Delete User entity # noqa: E501 + """Delete CSP Directives # noqa: E501 - User - represents entity interacting with platform # noqa: E501 + Context Security Police Directive # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_users(id, async_req=True) + >>> thread = api.delete_entity_csp_directives(id, async_req=True) >>> result = thread.get() Args: @@ -9282,20 +6804,19 @@ def delete_entity_users( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.delete_entity_users_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_csp_directives_endpoint.call_with_http_info(**kwargs) - def delete_entity_workspaces( + def delete_entity_export_templates( self, id, **kwargs ): - """Delete Workspace entity # noqa: E501 + """Delete Export Template entity # noqa: E501 - Space of the shared interest # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_workspaces(id, async_req=True) + >>> thread = api.delete_entity_export_templates(id, async_req=True) >>> result = thread.get() Args: @@ -9366,27 +6887,26 @@ def delete_entity_workspaces( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.delete_entity_workspaces_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_export_templates_endpoint.call_with_http_info(**kwargs) - def get_all_entities_color_palettes( + def delete_entity_identity_providers( self, + id, **kwargs ): - """Get all Color Pallettes # noqa: E501 + """Delete Identity Provider # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_color_palettes(async_req=True) + >>> thread = api.delete_entity_identity_providers(id, async_req=True) >>> result = thread.get() + Args: + id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -9419,7 +6939,7 @@ def get_all_entities_color_palettes( async_req (bool): execute request asynchronously Returns: - JsonApiColorPaletteOutList + None If the method is called asynchronously, returns the request thread. """ @@ -9448,28 +6968,28 @@ def get_all_entities_color_palettes( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_color_palettes_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.delete_entity_identity_providers_endpoint.call_with_http_info(**kwargs) - def get_all_entities_csp_directives( + def delete_entity_llm_endpoints( self, + id, **kwargs ): - """Get CSP Directives # noqa: E501 + """delete_entity_llm_endpoints # noqa: E501 - Context Security Police Directive # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_csp_directives(async_req=True) + >>> thread = api.delete_entity_llm_endpoints(id, async_req=True) >>> result = thread.get() + Args: + id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -9502,7 +7022,7 @@ def get_all_entities_csp_directives( async_req (bool): execute request asynchronously Returns: - JsonApiCspDirectiveOutList + None If the method is called asynchronously, returns the request thread. """ @@ -9531,27 +7051,28 @@ def get_all_entities_csp_directives( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_csp_directives_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.delete_entity_llm_endpoints_endpoint.call_with_http_info(**kwargs) - def get_all_entities_custom_geo_collections( + def delete_entity_llm_providers( self, + id, **kwargs ): - """get_all_entities_custom_geo_collections # noqa: E501 + """Delete LLM Provider entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_custom_geo_collections(async_req=True) + >>> thread = api.delete_entity_llm_providers(id, async_req=True) >>> result = thread.get() + Args: + id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -9584,7 +7105,7 @@ def get_all_entities_custom_geo_collections( async_req (bool): execute request asynchronously Returns: - JsonApiCustomGeoCollectionOutList + None If the method is called asynchronously, returns the request thread. """ @@ -9613,27 +7134,28 @@ def get_all_entities_custom_geo_collections( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_custom_geo_collections_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.delete_entity_llm_providers_endpoint.call_with_http_info(**kwargs) - def get_all_entities_data_source_identifiers( + def delete_entity_notification_channels( self, + id, **kwargs ): - """Get all Data Source Identifiers # noqa: E501 + """Delete Notification Channel entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_data_source_identifiers(async_req=True) + >>> thread = api.delete_entity_notification_channels(id, async_req=True) >>> result = thread.get() + Args: + id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -9666,7 +7188,7 @@ def get_all_entities_data_source_identifiers( async_req (bool): execute request asynchronously Returns: - JsonApiDataSourceIdentifierOutList + None If the method is called asynchronously, returns the request thread. """ @@ -9695,28 +7217,28 @@ def get_all_entities_data_source_identifiers( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_data_source_identifiers_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.delete_entity_notification_channels_endpoint.call_with_http_info(**kwargs) - def get_all_entities_data_sources( + def delete_entity_organization_settings( self, + id, **kwargs ): - """Get Data Source entities # noqa: E501 + """Delete Organization entity # noqa: E501 - Data Source - represents data source for the workspace # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_data_sources(async_req=True) + >>> thread = api.delete_entity_organization_settings(id, async_req=True) >>> result = thread.get() + Args: + id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -9749,7 +7271,7 @@ def get_all_entities_data_sources( async_req (bool): execute request asynchronously Returns: - JsonApiDataSourceOutList + None If the method is called asynchronously, returns the request thread. """ @@ -9778,28 +7300,28 @@ def get_all_entities_data_sources( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_data_sources_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.delete_entity_organization_settings_endpoint.call_with_http_info(**kwargs) - def get_all_entities_entitlements( + def delete_entity_themes( self, + id, **kwargs ): - """Get Entitlements # noqa: E501 + """Delete Theming # noqa: E501 - Space of the shared interest # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_entitlements(async_req=True) + >>> thread = api.delete_entity_themes(id, async_req=True) >>> result = thread.get() + Args: + id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -9832,7 +7354,7 @@ def get_all_entities_entitlements( async_req (bool): execute request asynchronously Returns: - JsonApiEntitlementOutList + None If the method is called asynchronously, returns the request thread. """ @@ -9861,27 +7383,29 @@ def get_all_entities_entitlements( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_entitlements_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.delete_entity_themes_endpoint.call_with_http_info(**kwargs) - def get_all_entities_export_templates( + def delete_entity_user_groups( self, + id, **kwargs ): - """GET all Export Template entities # noqa: E501 + """Delete UserGroup entity # noqa: E501 + User Group - creates tree-like structure for categorizing users # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_export_templates(async_req=True) + >>> thread = api.delete_entity_user_groups(id, async_req=True) >>> result = thread.get() + Args: + id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -9914,7 +7438,7 @@ def get_all_entities_export_templates( async_req (bool): execute request asynchronously Returns: - JsonApiExportTemplateOutList + None If the method is called asynchronously, returns the request thread. """ @@ -9943,27 +7467,29 @@ def get_all_entities_export_templates( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_export_templates_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.delete_entity_user_groups_endpoint.call_with_http_info(**kwargs) - def get_all_entities_identity_providers( + def delete_entity_users( self, + id, **kwargs ): - """Get all Identity Providers # noqa: E501 + """Delete User entity # noqa: E501 + User - represents entity interacting with platform # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_identity_providers(async_req=True) + >>> thread = api.delete_entity_users(id, async_req=True) >>> result = thread.get() + Args: + id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -9996,7 +7522,7 @@ def get_all_entities_identity_providers( async_req (bool): execute request asynchronously Returns: - JsonApiIdentityProviderOutList + None If the method is called asynchronously, returns the request thread. """ @@ -10025,28 +7551,29 @@ def get_all_entities_identity_providers( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_identity_providers_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.delete_entity_users_endpoint.call_with_http_info(**kwargs) - def get_all_entities_jwks( + def delete_entity_workspaces( self, + id, **kwargs ): - """Get all Jwks # noqa: E501 + """Delete Workspace entity # noqa: E501 - Returns all JSON web keys - used to verify JSON web tokens (Jwts) # noqa: E501 + Space of the shared interest # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_jwks(async_req=True) + >>> thread = api.delete_entity_workspaces(id, async_req=True) >>> result = thread.get() + Args: + id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -10079,7 +7606,7 @@ def get_all_entities_jwks( async_req (bool): execute request asynchronously Returns: - JsonApiJwkOutList + None If the method is called asynchronously, returns the request thread. """ @@ -10108,18 +7635,20 @@ def get_all_entities_jwks( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_jwks_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.delete_entity_workspaces_endpoint.call_with_http_info(**kwargs) - def get_all_entities_llm_endpoints( + def get_all_entities_color_palettes( self, **kwargs ): - """Get all LLM endpoint entities # noqa: E501 + """Get all Color Pallettes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_llm_endpoints(async_req=True) + >>> thread = api.get_all_entities_color_palettes(async_req=True) >>> result = thread.get() @@ -10161,7 +7690,7 @@ def get_all_entities_llm_endpoints( async_req (bool): execute request asynchronously Returns: - JsonApiLlmEndpointOutList + JsonApiColorPaletteOutList If the method is called asynchronously, returns the request thread. """ @@ -10190,18 +7719,19 @@ def get_all_entities_llm_endpoints( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_llm_endpoints_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_color_palettes_endpoint.call_with_http_info(**kwargs) - def get_all_entities_llm_providers( + def get_all_entities_csp_directives( self, **kwargs ): - """Get all LLM Provider entities # noqa: E501 + """Get CSP Directives # noqa: E501 + Context Security Police Directive # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_llm_providers(async_req=True) + >>> thread = api.get_all_entities_csp_directives(async_req=True) >>> result = thread.get() @@ -10243,7 +7773,7 @@ def get_all_entities_llm_providers( async_req (bool): execute request asynchronously Returns: - JsonApiLlmProviderOutList + JsonApiCspDirectiveOutList If the method is called asynchronously, returns the request thread. """ @@ -10272,18 +7802,18 @@ def get_all_entities_llm_providers( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_llm_providers_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_csp_directives_endpoint.call_with_http_info(**kwargs) - def get_all_entities_notification_channel_identifiers( + def get_all_entities_data_source_identifiers( self, **kwargs ): - """get_all_entities_notification_channel_identifiers # noqa: E501 + """Get all Data Source Identifiers # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_notification_channel_identifiers(async_req=True) + >>> thread = api.get_all_entities_data_source_identifiers(async_req=True) >>> result = thread.get() @@ -10325,7 +7855,7 @@ def get_all_entities_notification_channel_identifiers( async_req (bool): execute request asynchronously Returns: - JsonApiNotificationChannelIdentifierOutList + JsonApiDataSourceIdentifierOutList If the method is called asynchronously, returns the request thread. """ @@ -10354,18 +7884,19 @@ def get_all_entities_notification_channel_identifiers( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_notification_channel_identifiers_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_data_source_identifiers_endpoint.call_with_http_info(**kwargs) - def get_all_entities_notification_channels( + def get_all_entities_entitlements( self, **kwargs ): - """Get all Notification Channel entities # noqa: E501 + """Get Entitlements # noqa: E501 + Space of the shared interest # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_notification_channels(async_req=True) + >>> thread = api.get_all_entities_entitlements(async_req=True) >>> result = thread.get() @@ -10407,7 +7938,7 @@ def get_all_entities_notification_channels( async_req (bool): execute request asynchronously Returns: - JsonApiNotificationChannelOutList + JsonApiEntitlementOutList If the method is called asynchronously, returns the request thread. """ @@ -10436,18 +7967,18 @@ def get_all_entities_notification_channels( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_notification_channels_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_entitlements_endpoint.call_with_http_info(**kwargs) - def get_all_entities_organization_settings( + def get_all_entities_export_templates( self, **kwargs ): - """Get Organization entities # noqa: E501 + """GET all Export Template entities # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_organization_settings(async_req=True) + >>> thread = api.get_all_entities_export_templates(async_req=True) >>> result = thread.get() @@ -10489,7 +8020,7 @@ def get_all_entities_organization_settings( async_req (bool): execute request asynchronously Returns: - JsonApiOrganizationSettingOutList + JsonApiExportTemplateOutList If the method is called asynchronously, returns the request thread. """ @@ -10518,18 +8049,18 @@ def get_all_entities_organization_settings( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_organization_settings_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_export_templates_endpoint.call_with_http_info(**kwargs) - def get_all_entities_themes( + def get_all_entities_identity_providers( self, **kwargs ): - """Get all Theming entities # noqa: E501 + """Get all Identity Providers # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_themes(async_req=True) + >>> thread = api.get_all_entities_identity_providers(async_req=True) >>> result = thread.get() @@ -10571,7 +8102,7 @@ def get_all_entities_themes( async_req (bool): execute request asynchronously Returns: - JsonApiThemeOutList + JsonApiIdentityProviderOutList If the method is called asynchronously, returns the request thread. """ @@ -10600,25 +8131,23 @@ def get_all_entities_themes( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_themes_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_identity_providers_endpoint.call_with_http_info(**kwargs) - def get_all_entities_user_groups( + def get_all_entities_llm_endpoints( self, **kwargs ): - """Get UserGroup entities # noqa: E501 + """Get all LLM endpoint entities # noqa: E501 - User Group - creates tree-like structure for categorizing users # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_user_groups(async_req=True) + >>> thread = api.get_all_entities_llm_endpoints(async_req=True) >>> result = thread.get() Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] @@ -10655,7 +8184,7 @@ def get_all_entities_user_groups( async_req (bool): execute request asynchronously Returns: - JsonApiUserGroupOutList + JsonApiLlmEndpointOutList If the method is called asynchronously, returns the request thread. """ @@ -10684,19 +8213,18 @@ def get_all_entities_user_groups( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_user_groups_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_llm_endpoints_endpoint.call_with_http_info(**kwargs) - def get_all_entities_user_identifiers( + def get_all_entities_llm_providers( self, **kwargs ): - """Get UserIdentifier entities # noqa: E501 + """Get all LLM Provider entities # noqa: E501 - UserIdentifier - represents entity interacting with platform # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_user_identifiers(async_req=True) + >>> thread = api.get_all_entities_llm_providers(async_req=True) >>> result = thread.get() @@ -10738,7 +8266,7 @@ def get_all_entities_user_identifiers( async_req (bool): execute request asynchronously Returns: - JsonApiUserIdentifierOutList + JsonApiLlmProviderOutList If the method is called asynchronously, returns the request thread. """ @@ -10767,25 +8295,23 @@ def get_all_entities_user_identifiers( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_user_identifiers_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_llm_providers_endpoint.call_with_http_info(**kwargs) - def get_all_entities_users( + def get_all_entities_notification_channel_identifiers( self, **kwargs ): - """Get User entities # noqa: E501 + """get_all_entities_notification_channel_identifiers # noqa: E501 - User - represents entity interacting with platform # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_users(async_req=True) + >>> thread = api.get_all_entities_notification_channel_identifiers(async_req=True) >>> result = thread.get() Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] @@ -10822,7 +8348,7 @@ def get_all_entities_users( async_req (bool): execute request asynchronously Returns: - JsonApiUserOutList + JsonApiNotificationChannelIdentifierOutList If the method is called asynchronously, returns the request thread. """ @@ -10851,25 +8377,23 @@ def get_all_entities_users( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_users_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_notification_channel_identifiers_endpoint.call_with_http_info(**kwargs) - def get_all_entities_workspaces( + def get_all_entities_notification_channels( self, **kwargs ): - """Get Workspace entities # noqa: E501 + """Get all Notification Channel entities # noqa: E501 - Space of the shared interest # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_workspaces(async_req=True) + >>> thread = api.get_all_entities_notification_channels(async_req=True) >>> result = thread.get() Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] @@ -10906,7 +8430,7 @@ def get_all_entities_workspaces( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceOutList + JsonApiNotificationChannelOutList If the method is called asynchronously, returns the request thread. """ @@ -10935,26 +8459,27 @@ def get_all_entities_workspaces( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_workspaces_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_notification_channels_endpoint.call_with_http_info(**kwargs) - def get_entity_color_palettes( + def get_all_entities_organization_settings( self, - id, **kwargs ): - """Get Color Pallette # noqa: E501 + """Get Organization entities # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_color_palettes(id, async_req=True) + >>> thread = api.get_all_entities_organization_settings(async_req=True) >>> result = thread.get() - Args: - id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -10987,7 +8512,7 @@ def get_entity_color_palettes( async_req (bool): execute request asynchronously Returns: - JsonApiColorPaletteOutDocument + JsonApiOrganizationSettingOutList If the method is called asynchronously, returns the request thread. """ @@ -11016,29 +8541,27 @@ def get_entity_color_palettes( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_color_palettes_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_organization_settings_endpoint.call_with_http_info(**kwargs) - def get_entity_csp_directives( + def get_all_entities_themes( self, - id, **kwargs ): - """Get CSP Directives # noqa: E501 + """Get all Theming entities # noqa: E501 - Context Security Police Directive # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_csp_directives(id, async_req=True) + >>> thread = api.get_all_entities_themes(async_req=True) >>> result = thread.get() - Args: - id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -11071,7 +8594,7 @@ def get_entity_csp_directives( async_req (bool): execute request asynchronously Returns: - JsonApiCspDirectiveOutDocument + JsonApiThemeOutList If the method is called asynchronously, returns the request thread. """ @@ -11100,28 +8623,29 @@ def get_entity_csp_directives( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_csp_directives_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_themes_endpoint.call_with_http_info(**kwargs) - def get_entity_custom_geo_collections( + def get_all_entities_user_groups( self, - id, **kwargs ): - """get_entity_custom_geo_collections # noqa: E501 + """Get UserGroup entities # noqa: E501 + User Group - creates tree-like structure for categorizing users # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_custom_geo_collections(id, async_req=True) + >>> thread = api.get_all_entities_user_groups(async_req=True) >>> result = thread.get() - Args: - id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -11154,7 +8678,7 @@ def get_entity_custom_geo_collections( async_req (bool): execute request asynchronously Returns: - JsonApiCustomGeoCollectionOutDocument + JsonApiUserGroupOutList If the method is called asynchronously, returns the request thread. """ @@ -11183,28 +8707,27 @@ def get_entity_custom_geo_collections( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_custom_geo_collections_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_user_groups_endpoint.call_with_http_info(**kwargs) - def get_entity_data_source_identifiers( + def get_all_entities_user_identifiers( self, - id, **kwargs ): - """Get Data Source Identifier # noqa: E501 + """Get UserIdentifier entities # noqa: E501 + UserIdentifier - represents entity interacting with platform # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_data_source_identifiers(id, async_req=True) + >>> thread = api.get_all_entities_user_identifiers(async_req=True) >>> result = thread.get() - Args: - id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -11238,7 +8761,7 @@ def get_entity_data_source_identifiers( async_req (bool): execute request asynchronously Returns: - JsonApiDataSourceIdentifierOutDocument + JsonApiUserIdentifierOutList If the method is called asynchronously, returns the request thread. """ @@ -11267,29 +8790,28 @@ def get_entity_data_source_identifiers( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_data_source_identifiers_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_user_identifiers_endpoint.call_with_http_info(**kwargs) - def get_entity_data_sources( + def get_all_entities_users( self, - id, **kwargs ): - """Get Data Source entity # noqa: E501 + """Get User entities # noqa: E501 - Data Source - represents data source for the workspace # noqa: E501 + User - represents entity interacting with platform # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_data_sources(id, async_req=True) + >>> thread = api.get_all_entities_users(async_req=True) >>> result = thread.get() - Args: - id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -11323,7 +8845,7 @@ def get_entity_data_sources( async_req (bool): execute request asynchronously Returns: - JsonApiDataSourceOutDocument + JsonApiUserOutList If the method is called asynchronously, returns the request thread. """ @@ -11352,29 +8874,29 @@ def get_entity_data_sources( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_data_sources_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_users_endpoint.call_with_http_info(**kwargs) - def get_entity_entitlements( + def get_all_entities_workspaces( self, - id, **kwargs ): - """Get Entitlement # noqa: E501 + """Get Workspace entities # noqa: E501 Space of the shared interest # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_entitlements(id, async_req=True) + >>> thread = api.get_all_entities_workspaces(async_req=True) >>> result = thread.get() - Args: - id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -11407,7 +8929,7 @@ def get_entity_entitlements( async_req (bool): execute request asynchronously Returns: - JsonApiEntitlementOutDocument + JsonApiWorkspaceOutList If the method is called asynchronously, returns the request thread. """ @@ -11436,21 +8958,19 @@ def get_entity_entitlements( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_entitlements_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_workspaces_endpoint.call_with_http_info(**kwargs) - def get_entity_export_templates( + def get_entity_color_palettes( self, id, **kwargs ): - """GET Export Template entity # noqa: E501 + """Get Color Pallette # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_export_templates(id, async_req=True) + >>> thread = api.get_entity_color_palettes(id, async_req=True) >>> result = thread.get() Args: @@ -11490,7 +9010,7 @@ def get_entity_export_templates( async_req (bool): execute request asynchronously Returns: - JsonApiExportTemplateOutDocument + JsonApiColorPaletteOutDocument If the method is called asynchronously, returns the request thread. """ @@ -11521,19 +9041,20 @@ def get_entity_export_templates( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.get_entity_export_templates_endpoint.call_with_http_info(**kwargs) + return self.get_entity_color_palettes_endpoint.call_with_http_info(**kwargs) - def get_entity_identity_providers( + def get_entity_csp_directives( self, id, **kwargs ): - """Get Identity Provider # noqa: E501 + """Get CSP Directives # noqa: E501 + Context Security Police Directive # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_identity_providers(id, async_req=True) + >>> thread = api.get_entity_csp_directives(id, async_req=True) >>> result = thread.get() Args: @@ -11573,7 +9094,7 @@ def get_entity_identity_providers( async_req (bool): execute request asynchronously Returns: - JsonApiIdentityProviderOutDocument + JsonApiCspDirectiveOutDocument If the method is called asynchronously, returns the request thread. """ @@ -11604,20 +9125,19 @@ def get_entity_identity_providers( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.get_entity_identity_providers_endpoint.call_with_http_info(**kwargs) + return self.get_entity_csp_directives_endpoint.call_with_http_info(**kwargs) - def get_entity_jwks( + def get_entity_data_source_identifiers( self, id, **kwargs ): - """Get Jwk # noqa: E501 + """Get Data Source Identifier # noqa: E501 - Returns JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_jwks(id, async_req=True) + >>> thread = api.get_entity_data_source_identifiers(id, async_req=True) >>> result = thread.get() Args: @@ -11625,6 +9145,7 @@ def get_entity_jwks( Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -11657,7 +9178,7 @@ def get_entity_jwks( async_req (bool): execute request asynchronously Returns: - JsonApiJwkOutDocument + JsonApiDataSourceIdentifierOutDocument If the method is called asynchronously, returns the request thread. """ @@ -11688,19 +9209,20 @@ def get_entity_jwks( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.get_entity_jwks_endpoint.call_with_http_info(**kwargs) + return self.get_entity_data_source_identifiers_endpoint.call_with_http_info(**kwargs) - def get_entity_llm_endpoints( + def get_entity_entitlements( self, id, **kwargs ): - """Get LLM endpoint entity # noqa: E501 + """Get Entitlement # noqa: E501 + Space of the shared interest # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_llm_endpoints(id, async_req=True) + >>> thread = api.get_entity_entitlements(id, async_req=True) >>> result = thread.get() Args: @@ -11740,7 +9262,7 @@ def get_entity_llm_endpoints( async_req (bool): execute request asynchronously Returns: - JsonApiLlmEndpointOutDocument + JsonApiEntitlementOutDocument If the method is called asynchronously, returns the request thread. """ @@ -11771,19 +9293,19 @@ def get_entity_llm_endpoints( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.get_entity_llm_endpoints_endpoint.call_with_http_info(**kwargs) + return self.get_entity_entitlements_endpoint.call_with_http_info(**kwargs) - def get_entity_llm_providers( + def get_entity_export_templates( self, id, **kwargs ): - """Get LLM Provider entity # noqa: E501 + """GET Export Template entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_llm_providers(id, async_req=True) + >>> thread = api.get_entity_export_templates(id, async_req=True) >>> result = thread.get() Args: @@ -11823,7 +9345,7 @@ def get_entity_llm_providers( async_req (bool): execute request asynchronously Returns: - JsonApiLlmProviderOutDocument + JsonApiExportTemplateOutDocument If the method is called asynchronously, returns the request thread. """ @@ -11854,19 +9376,19 @@ def get_entity_llm_providers( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.get_entity_llm_providers_endpoint.call_with_http_info(**kwargs) + return self.get_entity_export_templates_endpoint.call_with_http_info(**kwargs) - def get_entity_notification_channel_identifiers( + def get_entity_identity_providers( self, id, **kwargs ): - """get_entity_notification_channel_identifiers # noqa: E501 + """Get Identity Provider # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_notification_channel_identifiers(id, async_req=True) + >>> thread = api.get_entity_identity_providers(id, async_req=True) >>> result = thread.get() Args: @@ -11906,7 +9428,7 @@ def get_entity_notification_channel_identifiers( async_req (bool): execute request asynchronously Returns: - JsonApiNotificationChannelIdentifierOutDocument + JsonApiIdentityProviderOutDocument If the method is called asynchronously, returns the request thread. """ @@ -11937,19 +9459,19 @@ def get_entity_notification_channel_identifiers( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.get_entity_notification_channel_identifiers_endpoint.call_with_http_info(**kwargs) + return self.get_entity_identity_providers_endpoint.call_with_http_info(**kwargs) - def get_entity_notification_channels( + def get_entity_llm_endpoints( self, id, **kwargs ): - """Get Notification Channel entity # noqa: E501 + """Get LLM endpoint entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_notification_channels(id, async_req=True) + >>> thread = api.get_entity_llm_endpoints(id, async_req=True) >>> result = thread.get() Args: @@ -11989,7 +9511,7 @@ def get_entity_notification_channels( async_req (bool): execute request asynchronously Returns: - JsonApiNotificationChannelOutDocument + JsonApiLlmEndpointOutDocument If the method is called asynchronously, returns the request thread. """ @@ -12020,19 +9542,19 @@ def get_entity_notification_channels( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.get_entity_notification_channels_endpoint.call_with_http_info(**kwargs) + return self.get_entity_llm_endpoints_endpoint.call_with_http_info(**kwargs) - def get_entity_organization_settings( + def get_entity_llm_providers( self, id, **kwargs ): - """Get Organization entity # noqa: E501 + """Get LLM Provider entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_organization_settings(id, async_req=True) + >>> thread = api.get_entity_llm_providers(id, async_req=True) >>> result = thread.get() Args: @@ -12072,7 +9594,7 @@ def get_entity_organization_settings( async_req (bool): execute request asynchronously Returns: - JsonApiOrganizationSettingOutDocument + JsonApiLlmProviderOutDocument If the method is called asynchronously, returns the request thread. """ @@ -12103,19 +9625,19 @@ def get_entity_organization_settings( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.get_entity_organization_settings_endpoint.call_with_http_info(**kwargs) + return self.get_entity_llm_providers_endpoint.call_with_http_info(**kwargs) - def get_entity_themes( + def get_entity_notification_channel_identifiers( self, id, **kwargs ): - """Get Theming # noqa: E501 + """get_entity_notification_channel_identifiers # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_themes(id, async_req=True) + >>> thread = api.get_entity_notification_channel_identifiers(id, async_req=True) >>> result = thread.get() Args: @@ -12155,7 +9677,7 @@ def get_entity_themes( async_req (bool): execute request asynchronously Returns: - JsonApiThemeOutDocument + JsonApiNotificationChannelIdentifierOutDocument If the method is called asynchronously, returns the request thread. """ @@ -12186,20 +9708,19 @@ def get_entity_themes( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.get_entity_themes_endpoint.call_with_http_info(**kwargs) + return self.get_entity_notification_channel_identifiers_endpoint.call_with_http_info(**kwargs) - def get_entity_user_groups( + def get_entity_notification_channels( self, id, **kwargs ): - """Get UserGroup entity # noqa: E501 + """Get Notification Channel entity # noqa: E501 - User Group - creates tree-like structure for categorizing users # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_user_groups(id, async_req=True) + >>> thread = api.get_entity_notification_channels(id, async_req=True) >>> result = thread.get() Args: @@ -12207,7 +9728,6 @@ def get_entity_user_groups( Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -12240,7 +9760,7 @@ def get_entity_user_groups( async_req (bool): execute request asynchronously Returns: - JsonApiUserGroupOutDocument + JsonApiNotificationChannelOutDocument If the method is called asynchronously, returns the request thread. """ @@ -12271,20 +9791,19 @@ def get_entity_user_groups( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.get_entity_user_groups_endpoint.call_with_http_info(**kwargs) + return self.get_entity_notification_channels_endpoint.call_with_http_info(**kwargs) - def get_entity_user_identifiers( + def get_entity_organization_settings( self, id, **kwargs ): - """Get UserIdentifier entity # noqa: E501 + """Get Organization entity # noqa: E501 - UserIdentifier - represents basic information about entity interacting with platform # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_user_identifiers(id, async_req=True) + >>> thread = api.get_entity_organization_settings(id, async_req=True) >>> result = thread.get() Args: @@ -12324,7 +9843,7 @@ def get_entity_user_identifiers( async_req (bool): execute request asynchronously Returns: - JsonApiUserIdentifierOutDocument + JsonApiOrganizationSettingOutDocument If the method is called asynchronously, returns the request thread. """ @@ -12355,20 +9874,19 @@ def get_entity_user_identifiers( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.get_entity_user_identifiers_endpoint.call_with_http_info(**kwargs) + return self.get_entity_organization_settings_endpoint.call_with_http_info(**kwargs) - def get_entity_users( + def get_entity_themes( self, id, **kwargs ): - """Get User entity # noqa: E501 + """Get Theming # noqa: E501 - User - represents entity interacting with platform # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_users(id, async_req=True) + >>> thread = api.get_entity_themes(id, async_req=True) >>> result = thread.get() Args: @@ -12376,7 +9894,6 @@ def get_entity_users( Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -12409,7 +9926,7 @@ def get_entity_users( async_req (bool): execute request asynchronously Returns: - JsonApiUserOutDocument + JsonApiThemeOutDocument If the method is called asynchronously, returns the request thread. """ @@ -12440,20 +9957,20 @@ def get_entity_users( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.get_entity_users_endpoint.call_with_http_info(**kwargs) + return self.get_entity_themes_endpoint.call_with_http_info(**kwargs) - def get_entity_workspaces( + def get_entity_user_groups( self, id, **kwargs ): - """Get Workspace entity # noqa: E501 + """Get UserGroup entity # noqa: E501 - Space of the shared interest # noqa: E501 + User Group - creates tree-like structure for categorizing users # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_workspaces(id, async_req=True) + >>> thread = api.get_entity_user_groups(id, async_req=True) >>> result = thread.get() Args: @@ -12462,7 +9979,6 @@ def get_entity_workspaces( Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -12495,7 +10011,7 @@ def get_entity_workspaces( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceOutDocument + JsonApiUserGroupOutDocument If the method is called asynchronously, returns the request thread. """ @@ -12526,25 +10042,24 @@ def get_entity_workspaces( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.get_entity_workspaces_endpoint.call_with_http_info(**kwargs) + return self.get_entity_user_groups_endpoint.call_with_http_info(**kwargs) - def patch_entity_color_palettes( + def get_entity_user_identifiers( self, id, - json_api_color_palette_patch_document, **kwargs ): - """Patch Color Pallette # noqa: E501 + """Get UserIdentifier entity # noqa: E501 + UserIdentifier - represents basic information about entity interacting with platform # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.patch_entity_color_palettes(id, json_api_color_palette_patch_document, async_req=True) + >>> thread = api.get_entity_user_identifiers(id, async_req=True) >>> result = thread.get() Args: id (str): - json_api_color_palette_patch_document (JsonApiColorPalettePatchDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -12580,7 +10095,7 @@ def patch_entity_color_palettes( async_req (bool): execute request asynchronously Returns: - JsonApiColorPaletteOutDocument + JsonApiUserIdentifierOutDocument If the method is called asynchronously, returns the request thread. """ @@ -12611,31 +10126,28 @@ def patch_entity_color_palettes( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - kwargs['json_api_color_palette_patch_document'] = \ - json_api_color_palette_patch_document - return self.patch_entity_color_palettes_endpoint.call_with_http_info(**kwargs) + return self.get_entity_user_identifiers_endpoint.call_with_http_info(**kwargs) - def patch_entity_csp_directives( + def get_entity_users( self, id, - json_api_csp_directive_patch_document, **kwargs ): - """Patch CSP Directives # noqa: E501 + """Get User entity # noqa: E501 - Context Security Police Directive # noqa: E501 + User - represents entity interacting with platform # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.patch_entity_csp_directives(id, json_api_csp_directive_patch_document, async_req=True) + >>> thread = api.get_entity_users(id, async_req=True) >>> result = thread.get() Args: id (str): - json_api_csp_directive_patch_document (JsonApiCspDirectivePatchDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -12668,7 +10180,7 @@ def patch_entity_csp_directives( async_req (bool): execute request asynchronously Returns: - JsonApiCspDirectiveOutDocument + JsonApiUserOutDocument If the method is called asynchronously, returns the request thread. """ @@ -12699,30 +10211,29 @@ def patch_entity_csp_directives( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - kwargs['json_api_csp_directive_patch_document'] = \ - json_api_csp_directive_patch_document - return self.patch_entity_csp_directives_endpoint.call_with_http_info(**kwargs) + return self.get_entity_users_endpoint.call_with_http_info(**kwargs) - def patch_entity_custom_geo_collections( + def get_entity_workspaces( self, id, - json_api_custom_geo_collection_patch_document, **kwargs ): - """patch_entity_custom_geo_collections # noqa: E501 + """Get Workspace entity # noqa: E501 + Space of the shared interest # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.patch_entity_custom_geo_collections(id, json_api_custom_geo_collection_patch_document, async_req=True) + >>> thread = api.get_entity_workspaces(id, async_req=True) >>> result = thread.get() Args: id (str): - json_api_custom_geo_collection_patch_document (JsonApiCustomGeoCollectionPatchDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -12755,7 +10266,7 @@ def patch_entity_custom_geo_collections( async_req (bool): execute request asynchronously Returns: - JsonApiCustomGeoCollectionOutDocument + JsonApiWorkspaceOutDocument If the method is called asynchronously, returns the request thread. """ @@ -12786,28 +10297,25 @@ def patch_entity_custom_geo_collections( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - kwargs['json_api_custom_geo_collection_patch_document'] = \ - json_api_custom_geo_collection_patch_document - return self.patch_entity_custom_geo_collections_endpoint.call_with_http_info(**kwargs) + return self.get_entity_workspaces_endpoint.call_with_http_info(**kwargs) - def patch_entity_data_sources( + def patch_entity_color_palettes( self, id, - json_api_data_source_patch_document, + json_api_color_palette_patch_document, **kwargs ): - """Patch Data Source entity # noqa: E501 + """Patch Color Pallette # noqa: E501 - Data Source - represents data source for the workspace # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.patch_entity_data_sources(id, json_api_data_source_patch_document, async_req=True) + >>> thread = api.patch_entity_color_palettes(id, json_api_color_palette_patch_document, async_req=True) >>> result = thread.get() Args: id (str): - json_api_data_source_patch_document (JsonApiDataSourcePatchDocument): + json_api_color_palette_patch_document (JsonApiColorPalettePatchDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -12843,7 +10351,7 @@ def patch_entity_data_sources( async_req (bool): execute request asynchronously Returns: - JsonApiDataSourceOutDocument + JsonApiColorPaletteOutDocument If the method is called asynchronously, returns the request thread. """ @@ -12874,27 +10382,28 @@ def patch_entity_data_sources( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - kwargs['json_api_data_source_patch_document'] = \ - json_api_data_source_patch_document - return self.patch_entity_data_sources_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_color_palette_patch_document'] = \ + json_api_color_palette_patch_document + return self.patch_entity_color_palettes_endpoint.call_with_http_info(**kwargs) - def patch_entity_export_templates( + def patch_entity_csp_directives( self, id, - json_api_export_template_patch_document, + json_api_csp_directive_patch_document, **kwargs ): - """Patch Export Template entity # noqa: E501 + """Patch CSP Directives # noqa: E501 + Context Security Police Directive # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.patch_entity_export_templates(id, json_api_export_template_patch_document, async_req=True) + >>> thread = api.patch_entity_csp_directives(id, json_api_csp_directive_patch_document, async_req=True) >>> result = thread.get() Args: id (str): - json_api_export_template_patch_document (JsonApiExportTemplatePatchDocument): + json_api_csp_directive_patch_document (JsonApiCspDirectivePatchDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -12930,7 +10439,7 @@ def patch_entity_export_templates( async_req (bool): execute request asynchronously Returns: - JsonApiExportTemplateOutDocument + JsonApiCspDirectiveOutDocument If the method is called asynchronously, returns the request thread. """ @@ -12961,27 +10470,27 @@ def patch_entity_export_templates( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - kwargs['json_api_export_template_patch_document'] = \ - json_api_export_template_patch_document - return self.patch_entity_export_templates_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_csp_directive_patch_document'] = \ + json_api_csp_directive_patch_document + return self.patch_entity_csp_directives_endpoint.call_with_http_info(**kwargs) - def patch_entity_identity_providers( + def patch_entity_export_templates( self, id, - json_api_identity_provider_patch_document, + json_api_export_template_patch_document, **kwargs ): - """Patch Identity Provider # noqa: E501 + """Patch Export Template entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.patch_entity_identity_providers(id, json_api_identity_provider_patch_document, async_req=True) + >>> thread = api.patch_entity_export_templates(id, json_api_export_template_patch_document, async_req=True) >>> result = thread.get() Args: id (str): - json_api_identity_provider_patch_document (JsonApiIdentityProviderPatchDocument): + json_api_export_template_patch_document (JsonApiExportTemplatePatchDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -13017,7 +10526,7 @@ def patch_entity_identity_providers( async_req (bool): execute request asynchronously Returns: - JsonApiIdentityProviderOutDocument + JsonApiExportTemplateOutDocument If the method is called asynchronously, returns the request thread. """ @@ -13048,28 +10557,27 @@ def patch_entity_identity_providers( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - kwargs['json_api_identity_provider_patch_document'] = \ - json_api_identity_provider_patch_document - return self.patch_entity_identity_providers_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_export_template_patch_document'] = \ + json_api_export_template_patch_document + return self.patch_entity_export_templates_endpoint.call_with_http_info(**kwargs) - def patch_entity_jwks( + def patch_entity_identity_providers( self, id, - json_api_jwk_patch_document, + json_api_identity_provider_patch_document, **kwargs ): - """Patch Jwk # noqa: E501 + """Patch Identity Provider # noqa: E501 - Patches JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.patch_entity_jwks(id, json_api_jwk_patch_document, async_req=True) + >>> thread = api.patch_entity_identity_providers(id, json_api_identity_provider_patch_document, async_req=True) >>> result = thread.get() Args: id (str): - json_api_jwk_patch_document (JsonApiJwkPatchDocument): + json_api_identity_provider_patch_document (JsonApiIdentityProviderPatchDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -13105,7 +10613,7 @@ def patch_entity_jwks( async_req (bool): execute request asynchronously Returns: - JsonApiJwkOutDocument + JsonApiIdentityProviderOutDocument If the method is called asynchronously, returns the request thread. """ @@ -13136,9 +10644,9 @@ def patch_entity_jwks( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - kwargs['json_api_jwk_patch_document'] = \ - json_api_jwk_patch_document - return self.patch_entity_jwks_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_identity_provider_patch_document'] = \ + json_api_identity_provider_patch_document + return self.patch_entity_identity_providers_endpoint.call_with_http_info(**kwargs) def patch_entity_llm_endpoints( self, @@ -14017,181 +11525,6 @@ def update_entity_csp_directives( json_api_csp_directive_in_document return self.update_entity_csp_directives_endpoint.call_with_http_info(**kwargs) - def update_entity_custom_geo_collections( - self, - id, - json_api_custom_geo_collection_in_document, - **kwargs - ): - """update_entity_custom_geo_collections # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_custom_geo_collections(id, json_api_custom_geo_collection_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_custom_geo_collection_in_document (JsonApiCustomGeoCollectionInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCustomGeoCollectionOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_custom_geo_collection_in_document'] = \ - json_api_custom_geo_collection_in_document - return self.update_entity_custom_geo_collections_endpoint.call_with_http_info(**kwargs) - - def update_entity_data_sources( - self, - id, - json_api_data_source_in_document, - **kwargs - ): - """Put Data Source entity # noqa: E501 - - Data Source - represents data source for the workspace # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_data_sources(id, json_api_data_source_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_data_source_in_document (JsonApiDataSourceInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDataSourceOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_data_source_in_document'] = \ - json_api_data_source_in_document - return self.update_entity_data_sources_endpoint.call_with_http_info(**kwargs) - def update_entity_export_templates( self, id, @@ -14366,94 +11699,6 @@ def update_entity_identity_providers( json_api_identity_provider_in_document return self.update_entity_identity_providers_endpoint.call_with_http_info(**kwargs) - def update_entity_jwks( - self, - id, - json_api_jwk_in_document, - **kwargs - ): - """Put Jwk # noqa: E501 - - Updates JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_jwks(id, json_api_jwk_in_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_jwk_in_document (JsonApiJwkInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiJwkOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_jwk_in_document'] = \ - json_api_jwk_in_document - return self.update_entity_jwks_endpoint.call_with_http_info(**kwargs) - def update_entity_llm_endpoints( self, id, diff --git a/gooddata-api-client/gooddata_api_client/api/plugins_api.py b/gooddata-api-client/gooddata_api_client/api/plugins_api.py index e0aff407b..28729f57a 100644 --- a/gooddata-api-client/gooddata_api_client/api/plugins_api.py +++ b/gooddata-api-client/gooddata_api_client/api/plugins_api.py @@ -1099,7 +1099,7 @@ def search_entities_dashboard_plugins( entity_search_body, **kwargs ): - """Search request for DashboardPlugin # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/smart_functions_api.py b/gooddata-api-client/gooddata_api_client/api/smart_functions_api.py index acd5cc343..702bf3b3b 100644 --- a/gooddata-api-client/gooddata_api_client/api/smart_functions_api.py +++ b/gooddata-api-client/gooddata_api_client/api/smart_functions_api.py @@ -40,14 +40,18 @@ from gooddata_api_client.model.generate_title_request import GenerateTitleRequest from gooddata_api_client.model.generate_title_response import GenerateTitleResponse from gooddata_api_client.model.get_quality_issues_response import GetQualityIssuesResponse +from gooddata_api_client.model.list_llm_provider_models_request import ListLlmProviderModelsRequest +from gooddata_api_client.model.list_llm_provider_models_response import ListLlmProviderModelsResponse from gooddata_api_client.model.memory_item_created_by_users import MemoryItemCreatedByUsers from gooddata_api_client.model.quality_issues_calculation_status_response import QualityIssuesCalculationStatusResponse from gooddata_api_client.model.resolved_llm_endpoints import ResolvedLlmEndpoints from gooddata_api_client.model.search_request import SearchRequest from gooddata_api_client.model.search_result import SearchResult from gooddata_api_client.model.smart_function_response import SmartFunctionResponse +from gooddata_api_client.model.test_llm_provider_by_id_request import TestLlmProviderByIdRequest from gooddata_api_client.model.test_llm_provider_definition_request import TestLlmProviderDefinitionRequest from gooddata_api_client.model.test_llm_provider_response import TestLlmProviderResponse +from gooddata_api_client.model.trending_objects_result import TrendingObjectsResult from gooddata_api_client.model.trigger_quality_issues_calculation_response import TriggerQualityIssuesCalculationResponse from gooddata_api_client.model.validate_llm_endpoint_by_id_request import ValidateLLMEndpointByIdRequest from gooddata_api_client.model.validate_llm_endpoint_request import ValidateLLMEndpointRequest @@ -1111,6 +1115,105 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.list_llm_provider_models_endpoint = _Endpoint( + settings={ + 'response_type': (ListLlmProviderModelsResponse,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/ai/llmProvider/listModels', + 'operation_id': 'list_llm_provider_models', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'list_llm_provider_models_request', + ], + 'required': [ + 'list_llm_provider_models_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'list_llm_provider_models_request': + (ListLlmProviderModelsRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'list_llm_provider_models_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.list_llm_provider_models_by_id_endpoint = _Endpoint( + settings={ + 'response_type': (ListLlmProviderModelsResponse,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/ai/llmProvider/{llmProviderId}/listModels', + 'operation_id': 'list_llm_provider_models_by_id', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'llm_provider_id', + ], + 'required': [ + 'llm_provider_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'llm_provider_id': + (str,), + }, + 'attribute_map': { + 'llm_provider_id': 'llmProviderId', + }, + 'location_map': { + 'llm_provider_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.memory_created_by_users_endpoint = _Endpoint( settings={ 'response_type': (MemoryItemCreatedByUsers,), @@ -1341,6 +1444,7 @@ def __init__(self, api_client=None): params_map={ 'all': [ 'llm_provider_id', + 'test_llm_provider_by_id_request', ], 'required': [ 'llm_provider_id', @@ -1360,12 +1464,73 @@ def __init__(self, api_client=None): 'openapi_types': { 'llm_provider_id': (str,), + 'test_llm_provider_by_id_request': + (TestLlmProviderByIdRequest,), }, 'attribute_map': { 'llm_provider_id': 'llmProviderId', }, 'location_map': { 'llm_provider_id': 'path', + 'test_llm_provider_by_id_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.trending_objects_endpoint = _Endpoint( + settings={ + 'response_type': (TrendingObjectsResult,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/trendingObjects', + 'operation_id': 'trending_objects', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'workspace_id', + ] + }, + root_map={ + 'validations': { + ('workspace_id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + }, + 'location_map': { + 'workspace_id': 'path', }, 'collection_format_map': { } @@ -2941,6 +3106,172 @@ def get_quality_issues_calculation_status( process_id return self.get_quality_issues_calculation_status_endpoint.call_with_http_info(**kwargs) + def list_llm_provider_models( + self, + list_llm_provider_models_request, + **kwargs + ): + """List LLM Provider Models # noqa: E501 + + Lists models available on an LLM provider with a full definition. For Azure AI Foundry providers, the model family will be set to UNKNOWN because the endpoint does not expose the family. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_llm_provider_models(list_llm_provider_models_request, async_req=True) + >>> result = thread.get() + + Args: + list_llm_provider_models_request (ListLlmProviderModelsRequest): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + ListLlmProviderModelsResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['list_llm_provider_models_request'] = \ + list_llm_provider_models_request + return self.list_llm_provider_models_endpoint.call_with_http_info(**kwargs) + + def list_llm_provider_models_by_id( + self, + llm_provider_id, + **kwargs + ): + """List LLM Provider Models By Id # noqa: E501 + + Lists models available on an existing LLM provider by its ID. For Azure AI Foundry providers, the model family will be set to UNKNOWN because the endpoint does not expose the family. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_llm_provider_models_by_id(llm_provider_id, async_req=True) + >>> result = thread.get() + + Args: + llm_provider_id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + ListLlmProviderModelsResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['llm_provider_id'] = \ + llm_provider_id + return self.list_llm_provider_models_by_id_endpoint.call_with_http_info(**kwargs) + def memory_created_by_users( self, workspace_id, @@ -3291,6 +3622,7 @@ def test_llm_provider_by_id( llm_provider_id (str): Keyword Args: + test_llm_provider_by_id_request (TestLlmProviderByIdRequest): [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -3356,6 +3688,89 @@ def test_llm_provider_by_id( llm_provider_id return self.test_llm_provider_by_id_endpoint.call_with_http_info(**kwargs) + def trending_objects( + self, + workspace_id, + **kwargs + ): + """Get Trending Analytics Catalog Objects # noqa: E501 + + Returns a list of trending objects for this workspace # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.trending_objects(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): Workspace identifier + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + TrendingObjectsResult + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.trending_objects_endpoint.call_with_http_info(**kwargs) + def trigger_quality_issues_calculation( self, workspace_id, diff --git a/gooddata-api-client/gooddata_api_client/api/user_data_filter_controller_api.py b/gooddata-api-client/gooddata_api_client/api/user_data_filter_controller_api.py new file mode 100644 index 000000000..528abd445 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/user_data_filter_controller_api.py @@ -0,0 +1,1305 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint +from gooddata_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from gooddata_api_client.model.entity_search_body import EntitySearchBody +from gooddata_api_client.model.json_api_user_data_filter_in_document import JsonApiUserDataFilterInDocument +from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.model.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList +from gooddata_api_client.model.json_api_user_data_filter_patch_document import JsonApiUserDataFilterPatchDocument +from gooddata_api_client.model.json_api_user_data_filter_post_optional_id_document import JsonApiUserDataFilterPostOptionalIdDocument + + +class UserDataFilterControllerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_entity_user_data_filters_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiUserDataFilterOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters', + 'operation_id': 'create_entity_user_data_filters', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_user_data_filter_post_optional_id_document', + 'include', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_user_data_filter_post_optional_id_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "USERS": "users", + "USERGROUPS": "userGroups", + "FACTS": "facts", + "ATTRIBUTES": "attributes", + "LABELS": "labels", + "METRICS": "metrics", + "DATASETS": "datasets", + "USER": "user", + "USERGROUP": "userGroup", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'json_api_user_data_filter_post_optional_id_document': + (JsonApiUserDataFilterPostOptionalIdDocument,), + 'include': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'include': 'include', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_user_data_filter_post_optional_id_document': 'body', + 'include': 'query', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.delete_entity_user_data_filters_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', + 'operation_id': 'delete_entity_user_data_filters', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_entities_user_data_filters_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiUserDataFilterOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters', + 'operation_id': 'get_all_entities_user_data_filters', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'origin', + 'filter', + 'include', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('include',): { + + "USERS": "users", + "USERGROUPS": "userGroups", + "FACTS": "facts", + "ATTRIBUTES": "attributes", + "LABELS": "labels", + "METRICS": "metrics", + "DATASETS": "datasets", + "USER": "user", + "USERGROUP": "userGroup", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'origin': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'filter': 'filter', + 'include': 'include', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'origin': 'query', + 'filter': 'query', + 'include': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_user_data_filters_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiUserDataFilterOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', + 'operation_id': 'get_entity_user_data_filters', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + 'include', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "USERS": "users", + "USERGROUPS": "userGroups", + "FACTS": "facts", + "ATTRIBUTES": "attributes", + "LABELS": "labels", + "METRICS": "metrics", + "DATASETS": "datasets", + "USER": "user", + "USERGROUP": "userGroup", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + 'include': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.patch_entity_user_data_filters_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiUserDataFilterOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', + 'operation_id': 'patch_entity_user_data_filters', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_user_data_filter_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_user_data_filter_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "USERS": "users", + "USERGROUPS": "userGroups", + "FACTS": "facts", + "ATTRIBUTES": "attributes", + "LABELS": "labels", + "METRICS": "metrics", + "DATASETS": "datasets", + "USER": "user", + "USERGROUP": "userGroup", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_user_data_filter_patch_document': + (JsonApiUserDataFilterPatchDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_user_data_filter_patch_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.search_entities_user_data_filters_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiUserDataFilterOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters/search', + 'operation_id': 'search_entities_user_data_filters', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'entity_search_body', + 'origin', + 'x_gdc_validate_relations', + ], + 'required': [ + 'workspace_id', + 'entity_search_body', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'entity_search_body': + (EntitySearchBody,), + 'origin': + (str,), + 'x_gdc_validate_relations': + (bool,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + }, + 'location_map': { + 'workspace_id': 'path', + 'entity_search_body': 'body', + 'origin': 'query', + 'x_gdc_validate_relations': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_entity_user_data_filters_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiUserDataFilterOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', + 'operation_id': 'update_entity_user_data_filters', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_user_data_filter_in_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_user_data_filter_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "USERS": "users", + "USERGROUPS": "userGroups", + "FACTS": "facts", + "ATTRIBUTES": "attributes", + "LABELS": "labels", + "METRICS": "metrics", + "DATASETS": "datasets", + "USER": "user", + "USERGROUP": "userGroup", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_user_data_filter_in_document': + (JsonApiUserDataFilterInDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_user_data_filter_in_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + + def create_entity_user_data_filters( + self, + workspace_id, + json_api_user_data_filter_post_optional_id_document, + **kwargs + ): + """Post User Data Filters # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_user_data_filters(workspace_id, json_api_user_data_filter_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_user_data_filter_post_optional_id_document (JsonApiUserDataFilterPostOptionalIdDocument): + + Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiUserDataFilterOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['json_api_user_data_filter_post_optional_id_document'] = \ + json_api_user_data_filter_post_optional_id_document + return self.create_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) + + def delete_entity_user_data_filters( + self, + workspace_id, + object_id, + **kwargs + ): + """Delete a User Data Filter # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_entity_user_data_filters(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_user_data_filters( + self, + workspace_id, + **kwargs + ): + """Get all User Data Filters # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_user_data_filters(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiUserDataFilterOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_user_data_filters_endpoint.call_with_http_info(**kwargs) + + def get_entity_user_data_filters( + self, + workspace_id, + object_id, + **kwargs + ): + """Get a User Data Filter # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_user_data_filters(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiUserDataFilterOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) + + def patch_entity_user_data_filters( + self, + workspace_id, + object_id, + json_api_user_data_filter_patch_document, + **kwargs + ): + """Patch a User Data Filter # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_user_data_filter_patch_document (JsonApiUserDataFilterPatchDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiUserDataFilterOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_user_data_filter_patch_document'] = \ + json_api_user_data_filter_patch_document + return self.patch_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) + + def search_entities_user_data_filters( + self, + workspace_id, + entity_search_body, + **kwargs + ): + """The search endpoint (beta) # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_entities_user_data_filters(workspace_id, entity_search_body, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiUserDataFilterOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['entity_search_body'] = \ + entity_search_body + return self.search_entities_user_data_filters_endpoint.call_with_http_info(**kwargs) + + def update_entity_user_data_filters( + self, + workspace_id, + object_id, + json_api_user_data_filter_in_document, + **kwargs + ): + """Put a User Data Filter # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_user_data_filter_in_document (JsonApiUserDataFilterInDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiUserDataFilterOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_user_data_filter_in_document'] = \ + json_api_user_data_filter_in_document + return self.update_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/user_setting_controller_api.py b/gooddata-api-client/gooddata_api_client/api/user_setting_controller_api.py new file mode 100644 index 000000000..becbbdcba --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/user_setting_controller_api.py @@ -0,0 +1,834 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint +from gooddata_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from gooddata_api_client.model.json_api_user_setting_in_document import JsonApiUserSettingInDocument +from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.model.json_api_user_setting_out_list import JsonApiUserSettingOutList + + +class UserSettingControllerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_entity_user_settings_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiUserSettingOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings', + 'operation_id': 'create_entity_user_settings', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'user_id', + 'json_api_user_setting_in_document', + ], + 'required': [ + 'user_id', + 'json_api_user_setting_in_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'user_id': + (str,), + 'json_api_user_setting_in_document': + (JsonApiUserSettingInDocument,), + }, + 'attribute_map': { + 'user_id': 'userId', + }, + 'location_map': { + 'user_id': 'path', + 'json_api_user_setting_in_document': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.delete_entity_user_settings_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings/{id}', + 'operation_id': 'delete_entity_user_settings', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'user_id', + 'id', + 'filter', + ], + 'required': [ + 'user_id', + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'user_id': + (str,), + 'id': + (str,), + 'filter': + (str,), + }, + 'attribute_map': { + 'user_id': 'userId', + 'id': 'id', + 'filter': 'filter', + }, + 'location_map': { + 'user_id': 'path', + 'id': 'path', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_entities_user_settings_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiUserSettingOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings', + 'operation_id': 'get_all_entities_user_settings', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'user_id', + 'filter', + 'page', + 'size', + 'sort', + 'meta_include', + ], + 'required': [ + 'user_id', + ], + 'nullable': [ + ], + 'enum': [ + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('meta_include',): { + + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'user_id': + (str,), + 'filter': + (str,), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'user_id': 'userId', + 'filter': 'filter', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'user_id': 'path', + 'filter': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_user_settings_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiUserSettingOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings/{id}', + 'operation_id': 'get_entity_user_settings', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'user_id', + 'id', + 'filter', + ], + 'required': [ + 'user_id', + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'user_id': + (str,), + 'id': + (str,), + 'filter': + (str,), + }, + 'attribute_map': { + 'user_id': 'userId', + 'id': 'id', + 'filter': 'filter', + }, + 'location_map': { + 'user_id': 'path', + 'id': 'path', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.update_entity_user_settings_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiUserSettingOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings/{id}', + 'operation_id': 'update_entity_user_settings', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'user_id', + 'id', + 'json_api_user_setting_in_document', + 'filter', + ], + 'required': [ + 'user_id', + 'id', + 'json_api_user_setting_in_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'user_id': + (str,), + 'id': + (str,), + 'json_api_user_setting_in_document': + (JsonApiUserSettingInDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'user_id': 'userId', + 'id': 'id', + 'filter': 'filter', + }, + 'location_map': { + 'user_id': 'path', + 'id': 'path', + 'json_api_user_setting_in_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + + def create_entity_user_settings( + self, + user_id, + json_api_user_setting_in_document, + **kwargs + ): + """Post new user settings for the user # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_user_settings(user_id, json_api_user_setting_in_document, async_req=True) + >>> result = thread.get() + + Args: + user_id (str): + json_api_user_setting_in_document (JsonApiUserSettingInDocument): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiUserSettingOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['user_id'] = \ + user_id + kwargs['json_api_user_setting_in_document'] = \ + json_api_user_setting_in_document + return self.create_entity_user_settings_endpoint.call_with_http_info(**kwargs) + + def delete_entity_user_settings( + self, + user_id, + id, + **kwargs + ): + """Delete a setting for a user # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_entity_user_settings(user_id, id, async_req=True) + >>> result = thread.get() + + Args: + user_id (str): + id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['user_id'] = \ + user_id + kwargs['id'] = \ + id + return self.delete_entity_user_settings_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_user_settings( + self, + user_id, + **kwargs + ): + """List all settings for a user # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_user_settings(user_id, async_req=True) + >>> result = thread.get() + + Args: + user_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiUserSettingOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['user_id'] = \ + user_id + return self.get_all_entities_user_settings_endpoint.call_with_http_info(**kwargs) + + def get_entity_user_settings( + self, + user_id, + id, + **kwargs + ): + """Get a setting for a user # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_user_settings(user_id, id, async_req=True) + >>> result = thread.get() + + Args: + user_id (str): + id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiUserSettingOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['user_id'] = \ + user_id + kwargs['id'] = \ + id + return self.get_entity_user_settings_endpoint.call_with_http_info(**kwargs) + + def update_entity_user_settings( + self, + user_id, + id, + json_api_user_setting_in_document, + **kwargs + ): + """Put new user settings for the user # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_entity_user_settings(user_id, id, json_api_user_setting_in_document, async_req=True) + >>> result = thread.get() + + Args: + user_id (str): + id (str): + json_api_user_setting_in_document (JsonApiUserSettingInDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiUserSettingOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['user_id'] = \ + user_id + kwargs['id'] = \ + id + kwargs['json_api_user_setting_in_document'] = \ + json_api_user_setting_in_document + return self.update_entity_user_settings_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/visualization_object_api.py b/gooddata-api-client/gooddata_api_client/api/visualization_object_api.py index 917c6c617..c4a526452 100644 --- a/gooddata-api-client/gooddata_api_client/api/visualization_object_api.py +++ b/gooddata-api-client/gooddata_api_client/api/visualization_object_api.py @@ -1129,7 +1129,7 @@ def search_entities_visualization_objects( entity_search_body, **kwargs ): - """Search request for VisualizationObject # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/visualization_object_controller_api.py b/gooddata-api-client/gooddata_api_client/api/visualization_object_controller_api.py new file mode 100644 index 000000000..3008c6c39 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/visualization_object_controller_api.py @@ -0,0 +1,1305 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint +from gooddata_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from gooddata_api_client.model.entity_search_body import EntitySearchBody +from gooddata_api_client.model.json_api_visualization_object_in_document import JsonApiVisualizationObjectInDocument +from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.model.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList +from gooddata_api_client.model.json_api_visualization_object_patch_document import JsonApiVisualizationObjectPatchDocument +from gooddata_api_client.model.json_api_visualization_object_post_optional_id_document import JsonApiVisualizationObjectPostOptionalIdDocument + + +class VisualizationObjectControllerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_entity_visualization_objects_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiVisualizationObjectOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects', + 'operation_id': 'create_entity_visualization_objects', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_visualization_object_post_optional_id_document', + 'include', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_visualization_object_post_optional_id_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "FACTS": "facts", + "ATTRIBUTES": "attributes", + "LABELS": "labels", + "METRICS": "metrics", + "DATASETS": "datasets", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'json_api_visualization_object_post_optional_id_document': + (JsonApiVisualizationObjectPostOptionalIdDocument,), + 'include': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'include': 'include', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_visualization_object_post_optional_id_document': 'body', + 'include': 'query', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.delete_entity_visualization_objects_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', + 'operation_id': 'delete_entity_visualization_objects', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_entities_visualization_objects_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiVisualizationObjectOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects', + 'operation_id': 'get_all_entities_visualization_objects', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'origin', + 'filter', + 'include', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "FACTS": "facts", + "ATTRIBUTES": "attributes", + "LABELS": "labels", + "METRICS": "metrics", + "DATASETS": "datasets", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'origin': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'filter': 'filter', + 'include': 'include', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'origin': 'query', + 'filter': 'query', + 'include': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_visualization_objects_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiVisualizationObjectOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', + 'operation_id': 'get_entity_visualization_objects', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + 'include', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "FACTS": "facts", + "ATTRIBUTES": "attributes", + "LABELS": "labels", + "METRICS": "metrics", + "DATASETS": "datasets", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + 'include': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.patch_entity_visualization_objects_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiVisualizationObjectOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', + 'operation_id': 'patch_entity_visualization_objects', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_visualization_object_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_visualization_object_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "FACTS": "facts", + "ATTRIBUTES": "attributes", + "LABELS": "labels", + "METRICS": "metrics", + "DATASETS": "datasets", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_visualization_object_patch_document': + (JsonApiVisualizationObjectPatchDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_visualization_object_patch_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.search_entities_visualization_objects_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiVisualizationObjectOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/search', + 'operation_id': 'search_entities_visualization_objects', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'entity_search_body', + 'origin', + 'x_gdc_validate_relations', + ], + 'required': [ + 'workspace_id', + 'entity_search_body', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'entity_search_body': + (EntitySearchBody,), + 'origin': + (str,), + 'x_gdc_validate_relations': + (bool,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + }, + 'location_map': { + 'workspace_id': 'path', + 'entity_search_body': 'body', + 'origin': 'query', + 'x_gdc_validate_relations': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_entity_visualization_objects_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiVisualizationObjectOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', + 'operation_id': 'update_entity_visualization_objects', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_visualization_object_in_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_visualization_object_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "FACTS": "facts", + "ATTRIBUTES": "attributes", + "LABELS": "labels", + "METRICS": "metrics", + "DATASETS": "datasets", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_visualization_object_in_document': + (JsonApiVisualizationObjectInDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_visualization_object_in_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + + def create_entity_visualization_objects( + self, + workspace_id, + json_api_visualization_object_post_optional_id_document, + **kwargs + ): + """Post Visualization Objects # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_visualization_objects(workspace_id, json_api_visualization_object_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_visualization_object_post_optional_id_document (JsonApiVisualizationObjectPostOptionalIdDocument): + + Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiVisualizationObjectOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['json_api_visualization_object_post_optional_id_document'] = \ + json_api_visualization_object_post_optional_id_document + return self.create_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) + + def delete_entity_visualization_objects( + self, + workspace_id, + object_id, + **kwargs + ): + """Delete a Visualization Object # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_entity_visualization_objects(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_visualization_objects( + self, + workspace_id, + **kwargs + ): + """Get all Visualization Objects # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_visualization_objects(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiVisualizationObjectOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_visualization_objects_endpoint.call_with_http_info(**kwargs) + + def get_entity_visualization_objects( + self, + workspace_id, + object_id, + **kwargs + ): + """Get a Visualization Object # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_visualization_objects(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiVisualizationObjectOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) + + def patch_entity_visualization_objects( + self, + workspace_id, + object_id, + json_api_visualization_object_patch_document, + **kwargs + ): + """Patch a Visualization Object # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_visualization_object_patch_document (JsonApiVisualizationObjectPatchDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiVisualizationObjectOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_visualization_object_patch_document'] = \ + json_api_visualization_object_patch_document + return self.patch_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) + + def search_entities_visualization_objects( + self, + workspace_id, + entity_search_body, + **kwargs + ): + """The search endpoint (beta) # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_entities_visualization_objects(workspace_id, entity_search_body, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiVisualizationObjectOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['entity_search_body'] = \ + entity_search_body + return self.search_entities_visualization_objects_endpoint.call_with_http_info(**kwargs) + + def update_entity_visualization_objects( + self, + workspace_id, + object_id, + json_api_visualization_object_in_document, + **kwargs + ): + """Put a Visualization Object # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_visualization_object_in_document (JsonApiVisualizationObjectInDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiVisualizationObjectOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_visualization_object_in_document'] = \ + json_api_visualization_object_in_document + return self.update_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/workspace_data_filter_controller_api.py b/gooddata-api-client/gooddata_api_client/api/workspace_data_filter_controller_api.py new file mode 100644 index 000000000..c0996358d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/workspace_data_filter_controller_api.py @@ -0,0 +1,1269 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint +from gooddata_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from gooddata_api_client.model.entity_search_body import EntitySearchBody +from gooddata_api_client.model.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument +from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.model.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList +from gooddata_api_client.model.json_api_workspace_data_filter_patch_document import JsonApiWorkspaceDataFilterPatchDocument + + +class WorkspaceDataFilterControllerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_entity_workspace_data_filters_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceDataFilterOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters', + 'operation_id': 'create_entity_workspace_data_filters', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_workspace_data_filter_in_document', + 'include', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_workspace_data_filter_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "WORKSPACEDATAFILTERSETTINGS": "workspaceDataFilterSettings", + "FILTERSETTINGS": "filterSettings", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'json_api_workspace_data_filter_in_document': + (JsonApiWorkspaceDataFilterInDocument,), + 'include': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'include': 'include', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_workspace_data_filter_in_document': 'body', + 'include': 'query', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.delete_entity_workspace_data_filters_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', + 'operation_id': 'delete_entity_workspace_data_filters', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_entities_workspace_data_filters_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceDataFilterOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters', + 'operation_id': 'get_all_entities_workspace_data_filters', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'origin', + 'filter', + 'include', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('include',): { + + "WORKSPACEDATAFILTERSETTINGS": "workspaceDataFilterSettings", + "FILTERSETTINGS": "filterSettings", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'origin': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'filter': 'filter', + 'include': 'include', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'origin': 'query', + 'filter': 'query', + 'include': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_workspace_data_filters_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceDataFilterOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', + 'operation_id': 'get_entity_workspace_data_filters', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + 'include', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "WORKSPACEDATAFILTERSETTINGS": "workspaceDataFilterSettings", + "FILTERSETTINGS": "filterSettings", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + 'include': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.patch_entity_workspace_data_filters_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceDataFilterOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', + 'operation_id': 'patch_entity_workspace_data_filters', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_data_filter_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_data_filter_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "WORKSPACEDATAFILTERSETTINGS": "workspaceDataFilterSettings", + "FILTERSETTINGS": "filterSettings", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_workspace_data_filter_patch_document': + (JsonApiWorkspaceDataFilterPatchDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_workspace_data_filter_patch_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.search_entities_workspace_data_filters_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceDataFilterOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/search', + 'operation_id': 'search_entities_workspace_data_filters', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'entity_search_body', + 'origin', + 'x_gdc_validate_relations', + ], + 'required': [ + 'workspace_id', + 'entity_search_body', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'entity_search_body': + (EntitySearchBody,), + 'origin': + (str,), + 'x_gdc_validate_relations': + (bool,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + }, + 'location_map': { + 'workspace_id': 'path', + 'entity_search_body': 'body', + 'origin': 'query', + 'x_gdc_validate_relations': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_entity_workspace_data_filters_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceDataFilterOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', + 'operation_id': 'update_entity_workspace_data_filters', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_data_filter_in_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_data_filter_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "WORKSPACEDATAFILTERSETTINGS": "workspaceDataFilterSettings", + "FILTERSETTINGS": "filterSettings", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_workspace_data_filter_in_document': + (JsonApiWorkspaceDataFilterInDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_workspace_data_filter_in_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + + def create_entity_workspace_data_filters( + self, + workspace_id, + json_api_workspace_data_filter_in_document, + **kwargs + ): + """Post Workspace Data Filters # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_workspace_data_filters(workspace_id, json_api_workspace_data_filter_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_workspace_data_filter_in_document (JsonApiWorkspaceDataFilterInDocument): + + Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiWorkspaceDataFilterOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['json_api_workspace_data_filter_in_document'] = \ + json_api_workspace_data_filter_in_document + return self.create_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) + + def delete_entity_workspace_data_filters( + self, + workspace_id, + object_id, + **kwargs + ): + """Delete a Workspace Data Filter # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_entity_workspace_data_filters(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_workspace_data_filters( + self, + workspace_id, + **kwargs + ): + """Get all Workspace Data Filters # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_workspace_data_filters(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiWorkspaceDataFilterOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_workspace_data_filters_endpoint.call_with_http_info(**kwargs) + + def get_entity_workspace_data_filters( + self, + workspace_id, + object_id, + **kwargs + ): + """Get a Workspace Data Filter # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_workspace_data_filters(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiWorkspaceDataFilterOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) + + def patch_entity_workspace_data_filters( + self, + workspace_id, + object_id, + json_api_workspace_data_filter_patch_document, + **kwargs + ): + """Patch a Workspace Data Filter # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_workspace_data_filter_patch_document (JsonApiWorkspaceDataFilterPatchDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiWorkspaceDataFilterOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_workspace_data_filter_patch_document'] = \ + json_api_workspace_data_filter_patch_document + return self.patch_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) + + def search_entities_workspace_data_filters( + self, + workspace_id, + entity_search_body, + **kwargs + ): + """The search endpoint (beta) # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_entities_workspace_data_filters(workspace_id, entity_search_body, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiWorkspaceDataFilterOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['entity_search_body'] = \ + entity_search_body + return self.search_entities_workspace_data_filters_endpoint.call_with_http_info(**kwargs) + + def update_entity_workspace_data_filters( + self, + workspace_id, + object_id, + json_api_workspace_data_filter_in_document, + **kwargs + ): + """Put a Workspace Data Filter # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_workspace_data_filter_in_document (JsonApiWorkspaceDataFilterInDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiWorkspaceDataFilterOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_workspace_data_filter_in_document'] = \ + json_api_workspace_data_filter_in_document + return self.update_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/workspace_data_filter_setting_controller_api.py b/gooddata-api-client/gooddata_api_client/api/workspace_data_filter_setting_controller_api.py new file mode 100644 index 000000000..9c082b22a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/workspace_data_filter_setting_controller_api.py @@ -0,0 +1,1269 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint +from gooddata_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from gooddata_api_client.model.entity_search_body import EntitySearchBody +from gooddata_api_client.model.json_api_workspace_data_filter_setting_in_document import JsonApiWorkspaceDataFilterSettingInDocument +from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList +from gooddata_api_client.model.json_api_workspace_data_filter_setting_patch_document import JsonApiWorkspaceDataFilterSettingPatchDocument + + +class WorkspaceDataFilterSettingControllerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_entity_workspace_data_filter_settings_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceDataFilterSettingOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings', + 'operation_id': 'create_entity_workspace_data_filter_settings', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_workspace_data_filter_setting_in_document', + 'include', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_workspace_data_filter_setting_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "WORKSPACEDATAFILTERS": "workspaceDataFilters", + "WORKSPACEDATAFILTER": "workspaceDataFilter", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'json_api_workspace_data_filter_setting_in_document': + (JsonApiWorkspaceDataFilterSettingInDocument,), + 'include': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'include': 'include', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_workspace_data_filter_setting_in_document': 'body', + 'include': 'query', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.delete_entity_workspace_data_filter_settings_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', + 'operation_id': 'delete_entity_workspace_data_filter_settings', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_entities_workspace_data_filter_settings_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceDataFilterSettingOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings', + 'operation_id': 'get_all_entities_workspace_data_filter_settings', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'origin', + 'filter', + 'include', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('include',): { + + "WORKSPACEDATAFILTERS": "workspaceDataFilters", + "WORKSPACEDATAFILTER": "workspaceDataFilter", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'origin': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'filter': 'filter', + 'include': 'include', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'origin': 'query', + 'filter': 'query', + 'include': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_workspace_data_filter_settings_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceDataFilterSettingOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', + 'operation_id': 'get_entity_workspace_data_filter_settings', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + 'include', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "WORKSPACEDATAFILTERS": "workspaceDataFilters", + "WORKSPACEDATAFILTER": "workspaceDataFilter", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + 'include': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.patch_entity_workspace_data_filter_settings_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceDataFilterSettingOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', + 'operation_id': 'patch_entity_workspace_data_filter_settings', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_data_filter_setting_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_data_filter_setting_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "WORKSPACEDATAFILTERS": "workspaceDataFilters", + "WORKSPACEDATAFILTER": "workspaceDataFilter", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_workspace_data_filter_setting_patch_document': + (JsonApiWorkspaceDataFilterSettingPatchDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_workspace_data_filter_setting_patch_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.search_entities_workspace_data_filter_settings_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceDataFilterSettingOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/search', + 'operation_id': 'search_entities_workspace_data_filter_settings', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'entity_search_body', + 'origin', + 'x_gdc_validate_relations', + ], + 'required': [ + 'workspace_id', + 'entity_search_body', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'entity_search_body': + (EntitySearchBody,), + 'origin': + (str,), + 'x_gdc_validate_relations': + (bool,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + }, + 'location_map': { + 'workspace_id': 'path', + 'entity_search_body': 'body', + 'origin': 'query', + 'x_gdc_validate_relations': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_entity_workspace_data_filter_settings_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceDataFilterSettingOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', + 'operation_id': 'update_entity_workspace_data_filter_settings', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_data_filter_setting_in_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_data_filter_setting_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "WORKSPACEDATAFILTERS": "workspaceDataFilters", + "WORKSPACEDATAFILTER": "workspaceDataFilter", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_workspace_data_filter_setting_in_document': + (JsonApiWorkspaceDataFilterSettingInDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_workspace_data_filter_setting_in_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + + def create_entity_workspace_data_filter_settings( + self, + workspace_id, + json_api_workspace_data_filter_setting_in_document, + **kwargs + ): + """Post Settings for Workspace Data Filters # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_workspace_data_filter_settings(workspace_id, json_api_workspace_data_filter_setting_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_workspace_data_filter_setting_in_document (JsonApiWorkspaceDataFilterSettingInDocument): + + Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiWorkspaceDataFilterSettingOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['json_api_workspace_data_filter_setting_in_document'] = \ + json_api_workspace_data_filter_setting_in_document + return self.create_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) + + def delete_entity_workspace_data_filter_settings( + self, + workspace_id, + object_id, + **kwargs + ): + """Delete a Settings for Workspace Data Filter # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_entity_workspace_data_filter_settings(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_workspace_data_filter_settings( + self, + workspace_id, + **kwargs + ): + """Get all Settings for Workspace Data Filters # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_workspace_data_filter_settings(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiWorkspaceDataFilterSettingOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) + + def get_entity_workspace_data_filter_settings( + self, + workspace_id, + object_id, + **kwargs + ): + """Get a Setting for Workspace Data Filter # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_workspace_data_filter_settings(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiWorkspaceDataFilterSettingOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) + + def patch_entity_workspace_data_filter_settings( + self, + workspace_id, + object_id, + json_api_workspace_data_filter_setting_patch_document, + **kwargs + ): + """Patch a Settings for Workspace Data Filter # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_workspace_data_filter_setting_patch_document (JsonApiWorkspaceDataFilterSettingPatchDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiWorkspaceDataFilterSettingOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_workspace_data_filter_setting_patch_document'] = \ + json_api_workspace_data_filter_setting_patch_document + return self.patch_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) + + def search_entities_workspace_data_filter_settings( + self, + workspace_id, + entity_search_body, + **kwargs + ): + """The search endpoint (beta) # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_entities_workspace_data_filter_settings(workspace_id, entity_search_body, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiWorkspaceDataFilterSettingOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['entity_search_body'] = \ + entity_search_body + return self.search_entities_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) + + def update_entity_workspace_data_filter_settings( + self, + workspace_id, + object_id, + json_api_workspace_data_filter_setting_in_document, + **kwargs + ): + """Put a Settings for Workspace Data Filter # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_workspace_data_filter_setting_in_document (JsonApiWorkspaceDataFilterSettingInDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiWorkspaceDataFilterSettingOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_workspace_data_filter_setting_in_document'] = \ + json_api_workspace_data_filter_setting_in_document + return self.update_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/workspace_object_controller_api.py b/gooddata-api-client/gooddata_api_client/api/workspace_object_controller_api.py index 9cfa5864e..7edfcec64 100644 --- a/gooddata-api-client/gooddata_api_client/api/workspace_object_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/workspace_object_controller_api.py @@ -25,94 +25,17 @@ from gooddata_api_client.model.entity_search_body import EntitySearchBody from gooddata_api_client.model.json_api_aggregated_fact_out_document import JsonApiAggregatedFactOutDocument from gooddata_api_client.model.json_api_aggregated_fact_out_list import JsonApiAggregatedFactOutList -from gooddata_api_client.model.json_api_analytical_dashboard_in_document import JsonApiAnalyticalDashboardInDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList -from gooddata_api_client.model.json_api_analytical_dashboard_patch_document import JsonApiAnalyticalDashboardPatchDocument -from gooddata_api_client.model.json_api_analytical_dashboard_post_optional_id_document import JsonApiAnalyticalDashboardPostOptionalIdDocument -from gooddata_api_client.model.json_api_attribute_hierarchy_in_document import JsonApiAttributeHierarchyInDocument -from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument -from gooddata_api_client.model.json_api_attribute_hierarchy_out_list import JsonApiAttributeHierarchyOutList -from gooddata_api_client.model.json_api_attribute_hierarchy_patch_document import JsonApiAttributeHierarchyPatchDocument -from gooddata_api_client.model.json_api_attribute_out_document import JsonApiAttributeOutDocument -from gooddata_api_client.model.json_api_attribute_out_list import JsonApiAttributeOutList -from gooddata_api_client.model.json_api_attribute_patch_document import JsonApiAttributePatchDocument -from gooddata_api_client.model.json_api_automation_in_document import JsonApiAutomationInDocument -from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument -from gooddata_api_client.model.json_api_automation_out_list import JsonApiAutomationOutList -from gooddata_api_client.model.json_api_automation_patch_document import JsonApiAutomationPatchDocument from gooddata_api_client.model.json_api_automation_result_out_list import JsonApiAutomationResultOutList -from gooddata_api_client.model.json_api_custom_application_setting_in_document import JsonApiCustomApplicationSettingInDocument -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument -from gooddata_api_client.model.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList -from gooddata_api_client.model.json_api_custom_application_setting_patch_document import JsonApiCustomApplicationSettingPatchDocument -from gooddata_api_client.model.json_api_custom_application_setting_post_optional_id_document import JsonApiCustomApplicationSettingPostOptionalIdDocument -from gooddata_api_client.model.json_api_dashboard_plugin_in_document import JsonApiDashboardPluginInDocument -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument -from gooddata_api_client.model.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList -from gooddata_api_client.model.json_api_dashboard_plugin_patch_document import JsonApiDashboardPluginPatchDocument -from gooddata_api_client.model.json_api_dashboard_plugin_post_optional_id_document import JsonApiDashboardPluginPostOptionalIdDocument -from gooddata_api_client.model.json_api_dataset_out_document import JsonApiDatasetOutDocument -from gooddata_api_client.model.json_api_dataset_out_list import JsonApiDatasetOutList -from gooddata_api_client.model.json_api_dataset_patch_document import JsonApiDatasetPatchDocument -from gooddata_api_client.model.json_api_export_definition_in_document import JsonApiExportDefinitionInDocument -from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument -from gooddata_api_client.model.json_api_export_definition_out_list import JsonApiExportDefinitionOutList -from gooddata_api_client.model.json_api_export_definition_patch_document import JsonApiExportDefinitionPatchDocument -from gooddata_api_client.model.json_api_export_definition_post_optional_id_document import JsonApiExportDefinitionPostOptionalIdDocument -from gooddata_api_client.model.json_api_fact_out_document import JsonApiFactOutDocument -from gooddata_api_client.model.json_api_fact_out_list import JsonApiFactOutList -from gooddata_api_client.model.json_api_fact_patch_document import JsonApiFactPatchDocument -from gooddata_api_client.model.json_api_filter_context_in_document import JsonApiFilterContextInDocument -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument -from gooddata_api_client.model.json_api_filter_context_out_list import JsonApiFilterContextOutList -from gooddata_api_client.model.json_api_filter_context_patch_document import JsonApiFilterContextPatchDocument -from gooddata_api_client.model.json_api_filter_context_post_optional_id_document import JsonApiFilterContextPostOptionalIdDocument -from gooddata_api_client.model.json_api_filter_view_in_document import JsonApiFilterViewInDocument -from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument -from gooddata_api_client.model.json_api_filter_view_out_list import JsonApiFilterViewOutList -from gooddata_api_client.model.json_api_filter_view_patch_document import JsonApiFilterViewPatchDocument from gooddata_api_client.model.json_api_knowledge_recommendation_in_document import JsonApiKnowledgeRecommendationInDocument from gooddata_api_client.model.json_api_knowledge_recommendation_out_document import JsonApiKnowledgeRecommendationOutDocument from gooddata_api_client.model.json_api_knowledge_recommendation_out_list import JsonApiKnowledgeRecommendationOutList from gooddata_api_client.model.json_api_knowledge_recommendation_patch_document import JsonApiKnowledgeRecommendationPatchDocument from gooddata_api_client.model.json_api_knowledge_recommendation_post_optional_id_document import JsonApiKnowledgeRecommendationPostOptionalIdDocument -from gooddata_api_client.model.json_api_label_out_document import JsonApiLabelOutDocument -from gooddata_api_client.model.json_api_label_out_list import JsonApiLabelOutList -from gooddata_api_client.model.json_api_label_patch_document import JsonApiLabelPatchDocument from gooddata_api_client.model.json_api_memory_item_in_document import JsonApiMemoryItemInDocument from gooddata_api_client.model.json_api_memory_item_out_document import JsonApiMemoryItemOutDocument from gooddata_api_client.model.json_api_memory_item_out_list import JsonApiMemoryItemOutList from gooddata_api_client.model.json_api_memory_item_patch_document import JsonApiMemoryItemPatchDocument from gooddata_api_client.model.json_api_memory_item_post_optional_id_document import JsonApiMemoryItemPostOptionalIdDocument -from gooddata_api_client.model.json_api_metric_in_document import JsonApiMetricInDocument -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument -from gooddata_api_client.model.json_api_metric_out_list import JsonApiMetricOutList -from gooddata_api_client.model.json_api_metric_patch_document import JsonApiMetricPatchDocument -from gooddata_api_client.model.json_api_metric_post_optional_id_document import JsonApiMetricPostOptionalIdDocument -from gooddata_api_client.model.json_api_user_data_filter_in_document import JsonApiUserDataFilterInDocument -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument -from gooddata_api_client.model.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList -from gooddata_api_client.model.json_api_user_data_filter_patch_document import JsonApiUserDataFilterPatchDocument -from gooddata_api_client.model.json_api_user_data_filter_post_optional_id_document import JsonApiUserDataFilterPostOptionalIdDocument -from gooddata_api_client.model.json_api_visualization_object_in_document import JsonApiVisualizationObjectInDocument -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument -from gooddata_api_client.model.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList -from gooddata_api_client.model.json_api_visualization_object_patch_document import JsonApiVisualizationObjectPatchDocument -from gooddata_api_client.model.json_api_visualization_object_post_optional_id_document import JsonApiVisualizationObjectPostOptionalIdDocument -from gooddata_api_client.model.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList -from gooddata_api_client.model.json_api_workspace_data_filter_patch_document import JsonApiWorkspaceDataFilterPatchDocument -from gooddata_api_client.model.json_api_workspace_data_filter_setting_in_document import JsonApiWorkspaceDataFilterSettingInDocument -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList -from gooddata_api_client.model.json_api_workspace_data_filter_setting_patch_document import JsonApiWorkspaceDataFilterSettingPatchDocument -from gooddata_api_client.model.json_api_workspace_setting_in_document import JsonApiWorkspaceSettingInDocument -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument -from gooddata_api_client.model.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList -from gooddata_api_client.model.json_api_workspace_setting_patch_document import JsonApiWorkspaceSettingPatchDocument -from gooddata_api_client.model.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument class WorkspaceObjectControllerApi(object): @@ -126,25 +49,25 @@ def __init__(self, api_client=None): if api_client is None: api_client = ApiClient() self.api_client = api_client - self.create_entity_analytical_dashboards_endpoint = _Endpoint( + self.create_entity_knowledge_recommendations_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiAnalyticalDashboardOutDocument,), + 'response_type': (JsonApiKnowledgeRecommendationOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards', - 'operation_id': 'create_entity_analytical_dashboards', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations', + 'operation_id': 'create_entity_knowledge_recommendations', 'http_method': 'POST', 'servers': None, }, params_map={ 'all': [ 'workspace_id', - 'json_api_analytical_dashboard_post_optional_id_document', + 'json_api_knowledge_recommendation_post_optional_id_document', 'include', 'meta_include', ], 'required': [ 'workspace_id', - 'json_api_analytical_dashboard_post_optional_id_document', + 'json_api_knowledge_recommendation_post_optional_id_document', ], 'nullable': [ ], @@ -165,24 +88,15 @@ def __init__(self, api_client=None): 'allowed_values': { ('include',): { - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "LABELS": "labels", "METRICS": "metrics", - "DATASETS": "datasets", - "FILTERCONTEXTS": "filterContexts", - "DASHBOARDPLUGINS": "dashboardPlugins", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "CERTIFIEDBY": "certifiedBy", + "ANALYTICALDASHBOARDS": "analyticalDashboards", + "METRIC": "metric", + "ANALYTICALDASHBOARD": "analyticalDashboard", "ALL": "ALL" }, ('meta_include',): { - "PERMISSIONS": "permissions", "ORIGIN": "origin", - "ACCESSINFO": "accessInfo", "ALL": "all", "ALL": "ALL" }, @@ -190,8 +104,8 @@ def __init__(self, api_client=None): 'openapi_types': { 'workspace_id': (str,), - 'json_api_analytical_dashboard_post_optional_id_document': - (JsonApiAnalyticalDashboardPostOptionalIdDocument,), + 'json_api_knowledge_recommendation_post_optional_id_document': + (JsonApiKnowledgeRecommendationPostOptionalIdDocument,), 'include': ([str],), 'meta_include': @@ -204,7 +118,7 @@ def __init__(self, api_client=None): }, 'location_map': { 'workspace_id': 'path', - 'json_api_analytical_dashboard_post_optional_id_document': 'body', + 'json_api_knowledge_recommendation_post_optional_id_document': 'body', 'include': 'query', 'meta_include': 'query', }, @@ -225,25 +139,25 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.create_entity_attribute_hierarchies_endpoint = _Endpoint( + self.create_entity_memory_items_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiAttributeHierarchyOutDocument,), + 'response_type': (JsonApiMemoryItemOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies', - 'operation_id': 'create_entity_attribute_hierarchies', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/memoryItems', + 'operation_id': 'create_entity_memory_items', 'http_method': 'POST', 'servers': None, }, params_map={ 'all': [ 'workspace_id', - 'json_api_attribute_hierarchy_in_document', + 'json_api_memory_item_post_optional_id_document', 'include', 'meta_include', ], 'required': [ 'workspace_id', - 'json_api_attribute_hierarchy_in_document', + 'json_api_memory_item_post_optional_id_document', ], 'nullable': [ ], @@ -265,7 +179,6 @@ def __init__(self, api_client=None): ('include',): { "USERIDENTIFIERS": "userIdentifiers", - "ATTRIBUTES": "attributes", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", "ALL": "ALL" @@ -280,8 +193,8 @@ def __init__(self, api_client=None): 'openapi_types': { 'workspace_id': (str,), - 'json_api_attribute_hierarchy_in_document': - (JsonApiAttributeHierarchyInDocument,), + 'json_api_memory_item_post_optional_id_document': + (JsonApiMemoryItemPostOptionalIdDocument,), 'include': ([str],), 'meta_include': @@ -294,7 +207,7 @@ def __init__(self, api_client=None): }, 'location_map': { 'workspace_id': 'path', - 'json_api_attribute_hierarchy_in_document': 'body', + 'json_api_memory_item_post_optional_id_document': 'body', 'include': 'query', 'meta_include': 'query', }, @@ -315,201 +228,150 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.create_entity_automations_endpoint = _Endpoint( + self.delete_entity_knowledge_recommendations_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiAutomationOutDocument,), + 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automations', - 'operation_id': 'create_entity_automations', - 'http_method': 'POST', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}', + 'operation_id': 'delete_entity_knowledge_recommendations', + 'http_method': 'DELETE', 'servers': None, }, params_map={ 'all': [ 'workspace_id', - 'json_api_automation_in_document', - 'include', - 'meta_include', + 'object_id', + 'filter', ], 'required': [ 'workspace_id', - 'json_api_automation_in_document', + 'object_id', ], 'nullable': [ ], 'enum': [ - 'include', - 'meta_include', ], 'validation': [ - 'meta_include', ] }, root_map={ 'validations': { - ('meta_include',): { - - }, }, 'allowed_values': { - ('include',): { - - "NOTIFICATIONCHANNELS": "notificationChannels", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERIDENTIFIERS": "userIdentifiers", - "EXPORTDEFINITIONS": "exportDefinitions", - "USERS": "users", - "AUTOMATIONRESULTS": "automationResults", - "NOTIFICATIONCHANNEL": "notificationChannel", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "RECIPIENTS": "recipients", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, }, 'openapi_types': { 'workspace_id': (str,), - 'json_api_automation_in_document': - (JsonApiAutomationInDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), + 'object_id': + (str,), + 'filter': + (str,), }, 'attribute_map': { 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', + 'object_id': 'objectId', + 'filter': 'filter', }, 'location_map': { 'workspace_id': 'path', - 'json_api_automation_in_document': 'body', - 'include': 'query', - 'meta_include': 'query', + 'object_id': 'path', + 'filter': 'query', }, 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', } }, headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] + 'accept': [], + 'content_type': [], }, api_client=api_client ) - self.create_entity_custom_application_settings_endpoint = _Endpoint( + self.delete_entity_memory_items_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiCustomApplicationSettingOutDocument,), + 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings', - 'operation_id': 'create_entity_custom_application_settings', - 'http_method': 'POST', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}', + 'operation_id': 'delete_entity_memory_items', + 'http_method': 'DELETE', 'servers': None, }, params_map={ 'all': [ 'workspace_id', - 'json_api_custom_application_setting_post_optional_id_document', - 'meta_include', + 'object_id', + 'filter', ], 'required': [ 'workspace_id', - 'json_api_custom_application_setting_post_optional_id_document', + 'object_id', ], 'nullable': [ ], 'enum': [ - 'meta_include', ], 'validation': [ - 'meta_include', ] }, root_map={ 'validations': { - ('meta_include',): { - - }, }, 'allowed_values': { - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, }, 'openapi_types': { 'workspace_id': (str,), - 'json_api_custom_application_setting_post_optional_id_document': - (JsonApiCustomApplicationSettingPostOptionalIdDocument,), - 'meta_include': - ([str],), + 'object_id': + (str,), + 'filter': + (str,), }, 'attribute_map': { 'workspace_id': 'workspaceId', - 'meta_include': 'metaInclude', + 'object_id': 'objectId', + 'filter': 'filter', }, 'location_map': { 'workspace_id': 'path', - 'json_api_custom_application_setting_post_optional_id_document': 'body', - 'meta_include': 'query', + 'object_id': 'path', + 'filter': 'query', }, 'collection_format_map': { - 'meta_include': 'csv', } }, headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] + 'accept': [], + 'content_type': [], }, api_client=api_client ) - self.create_entity_dashboard_plugins_endpoint = _Endpoint( + self.get_all_entities_aggregated_facts_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiDashboardPluginOutDocument,), + 'response_type': (JsonApiAggregatedFactOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins', - 'operation_id': 'create_entity_dashboard_plugins', - 'http_method': 'POST', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts', + 'operation_id': 'get_all_entities_aggregated_facts', + 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ 'workspace_id', - 'json_api_dashboard_plugin_post_optional_id_document', + 'origin', + 'filter', 'include', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', 'meta_include', ], 'required': [ 'workspace_id', - 'json_api_dashboard_plugin_post_optional_id_document', ], 'nullable': [ ], 'enum': [ + 'origin', 'include', 'meta_include', ], @@ -524,16 +386,24 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, ('include',): { - "USERIDENTIFIERS": "userIdentifiers", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", + "DATASETS": "datasets", + "FACTS": "facts", + "DATASET": "dataset", + "SOURCEFACT": "sourceFact", "ALL": "ALL" }, ('meta_include',): { "ORIGIN": "origin", + "PAGE": "page", "ALL": "all", "ALL": "ALL" }, @@ -541,26 +411,48 @@ def __init__(self, api_client=None): 'openapi_types': { 'workspace_id': (str,), - 'json_api_dashboard_plugin_post_optional_id_document': - (JsonApiDashboardPluginPostOptionalIdDocument,), + 'origin': + (str,), + 'filter': + (str,), 'include': ([str],), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'x_gdc_validate_relations': + (bool,), 'meta_include': ([str],), }, 'attribute_map': { 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'filter': 'filter', 'include': 'include', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', 'meta_include': 'metaInclude', }, 'location_map': { 'workspace_id': 'path', - 'json_api_dashboard_plugin_post_optional_id_document': 'body', + 'origin': 'query', + 'filter': 'query', 'include': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'x_gdc_validate_relations': 'header', 'meta_include': 'query', }, 'collection_format_map': { 'include': 'csv', + 'sort': 'multi', 'meta_include': 'csv', } }, @@ -569,36 +461,38 @@ def __init__(self, api_client=None): 'application/json', 'application/vnd.gooddata.api+json' ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] + 'content_type': [], }, api_client=api_client ) - self.create_entity_export_definitions_endpoint = _Endpoint( + self.get_all_entities_knowledge_recommendations_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiExportDefinitionOutDocument,), + 'response_type': (JsonApiKnowledgeRecommendationOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions', - 'operation_id': 'create_entity_export_definitions', - 'http_method': 'POST', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations', + 'operation_id': 'get_all_entities_knowledge_recommendations', + 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ 'workspace_id', - 'json_api_export_definition_post_optional_id_document', + 'origin', + 'filter', 'include', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', 'meta_include', ], 'required': [ 'workspace_id', - 'json_api_export_definition_post_optional_id_document', ], 'nullable': [ ], 'enum': [ + 'origin', 'include', 'meta_include', ], @@ -613,22 +507,24 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, ('include',): { - "VISUALIZATIONOBJECTS": "visualizationObjects", + "METRICS": "metrics", "ANALYTICALDASHBOARDS": "analyticalDashboards", - "AUTOMATIONS": "automations", - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECT": "visualizationObject", + "METRIC": "metric", "ANALYTICALDASHBOARD": "analyticalDashboard", - "AUTOMATION": "automation", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", "ALL": "ALL" }, ('meta_include',): { "ORIGIN": "origin", + "PAGE": "page", "ALL": "all", "ALL": "ALL" }, @@ -636,26 +532,48 @@ def __init__(self, api_client=None): 'openapi_types': { 'workspace_id': (str,), - 'json_api_export_definition_post_optional_id_document': - (JsonApiExportDefinitionPostOptionalIdDocument,), + 'origin': + (str,), + 'filter': + (str,), 'include': ([str],), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'x_gdc_validate_relations': + (bool,), 'meta_include': ([str],), }, 'attribute_map': { 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'filter': 'filter', 'include': 'include', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', 'meta_include': 'metaInclude', }, 'location_map': { 'workspace_id': 'path', - 'json_api_export_definition_post_optional_id_document': 'body', + 'origin': 'query', + 'filter': 'query', 'include': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'x_gdc_validate_relations': 'header', 'meta_include': 'query', }, 'collection_format_map': { 'include': 'csv', + 'sort': 'multi', 'meta_include': 'csv', } }, @@ -664,36 +582,38 @@ def __init__(self, api_client=None): 'application/json', 'application/vnd.gooddata.api+json' ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] + 'content_type': [], }, api_client=api_client ) - self.create_entity_filter_contexts_endpoint = _Endpoint( + self.get_all_entities_memory_items_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiFilterContextOutDocument,), + 'response_type': (JsonApiMemoryItemOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts', - 'operation_id': 'create_entity_filter_contexts', - 'http_method': 'POST', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/memoryItems', + 'operation_id': 'get_all_entities_memory_items', + 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ 'workspace_id', - 'json_api_filter_context_post_optional_id_document', + 'origin', + 'filter', 'include', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', 'meta_include', ], 'required': [ 'workspace_id', - 'json_api_filter_context_post_optional_id_document', ], 'nullable': [ ], 'enum': [ + 'origin', 'include', 'meta_include', ], @@ -708,16 +628,23 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { - ('include',): { + ('origin',): { - "ATTRIBUTES": "attributes", - "DATASETS": "datasets", - "LABELS": "labels", + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", "ALL": "ALL" }, ('meta_include',): { "ORIGIN": "origin", + "PAGE": "page", "ALL": "all", "ALL": "ALL" }, @@ -725,26 +652,48 @@ def __init__(self, api_client=None): 'openapi_types': { 'workspace_id': (str,), - 'json_api_filter_context_post_optional_id_document': - (JsonApiFilterContextPostOptionalIdDocument,), + 'origin': + (str,), + 'filter': + (str,), 'include': ([str],), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'x_gdc_validate_relations': + (bool,), 'meta_include': ([str],), }, 'attribute_map': { 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'filter': 'filter', 'include': 'include', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', 'meta_include': 'metaInclude', }, 'location_map': { 'workspace_id': 'path', - 'json_api_filter_context_post_optional_id_document': 'body', + 'origin': 'query', + 'filter': 'query', 'include': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'x_gdc_validate_relations': 'header', 'meta_include': 'query', }, 'collection_format_map': { 'include': 'csv', + 'sort': 'multi', 'meta_include': 'csv', } }, @@ -753,72 +702,97 @@ def __init__(self, api_client=None): 'application/json', 'application/vnd.gooddata.api+json' ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] + 'content_type': [], }, api_client=api_client ) - self.create_entity_filter_views_endpoint = _Endpoint( + self.get_entity_aggregated_facts_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiFilterViewOutDocument,), + 'response_type': (JsonApiAggregatedFactOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews', - 'operation_id': 'create_entity_filter_views', - 'http_method': 'POST', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/{objectId}', + 'operation_id': 'get_entity_aggregated_facts', + 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ 'workspace_id', - 'json_api_filter_view_in_document', + 'object_id', + 'filter', 'include', + 'x_gdc_validate_relations', + 'meta_include', ], 'required': [ 'workspace_id', - 'json_api_filter_view_in_document', + 'object_id', ], 'nullable': [ ], 'enum': [ 'include', + 'meta_include', ], 'validation': [ + 'meta_include', ] }, root_map={ 'validations': { + ('meta_include',): { + + }, }, 'allowed_values': { ('include',): { - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERS": "users", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "USER": "user", + "DATASETS": "datasets", + "FACTS": "facts", + "DATASET": "dataset", + "SOURCEFACT": "sourceFact", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", "ALL": "ALL" }, }, 'openapi_types': { 'workspace_id': (str,), - 'json_api_filter_view_in_document': - (JsonApiFilterViewInDocument,), + 'object_id': + (str,), + 'filter': + (str,), 'include': ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), }, 'attribute_map': { 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', 'include': 'include', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', }, 'location_map': { 'workspace_id': 'path', - 'json_api_filter_view_in_document': 'body', + 'object_id': 'path', + 'filter': 'query', 'include': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', }, 'collection_format_map': { 'include': 'csv', + 'meta_include': 'csv', } }, headers_map={ @@ -826,32 +800,31 @@ def __init__(self, api_client=None): 'application/json', 'application/vnd.gooddata.api+json' ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] + 'content_type': [], }, api_client=api_client ) - self.create_entity_knowledge_recommendations_endpoint = _Endpoint( + self.get_entity_knowledge_recommendations_endpoint = _Endpoint( settings={ 'response_type': (JsonApiKnowledgeRecommendationOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations', - 'operation_id': 'create_entity_knowledge_recommendations', - 'http_method': 'POST', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}', + 'operation_id': 'get_entity_knowledge_recommendations', + 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ 'workspace_id', - 'json_api_knowledge_recommendation_post_optional_id_document', + 'object_id', + 'filter', 'include', + 'x_gdc_validate_relations', 'meta_include', ], 'required': [ 'workspace_id', - 'json_api_knowledge_recommendation_post_optional_id_document', + 'object_id', ], 'nullable': [ ], @@ -888,22 +861,31 @@ def __init__(self, api_client=None): 'openapi_types': { 'workspace_id': (str,), - 'json_api_knowledge_recommendation_post_optional_id_document': - (JsonApiKnowledgeRecommendationPostOptionalIdDocument,), + 'object_id': + (str,), + 'filter': + (str,), 'include': ([str],), + 'x_gdc_validate_relations': + (bool,), 'meta_include': ([str],), }, 'attribute_map': { 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', 'include': 'include', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', 'meta_include': 'metaInclude', }, 'location_map': { 'workspace_id': 'path', - 'json_api_knowledge_recommendation_post_optional_id_document': 'body', + 'object_id': 'path', + 'filter': 'query', 'include': 'query', + 'x_gdc_validate_relations': 'header', 'meta_include': 'query', }, 'collection_format_map': { @@ -916,32 +898,31 @@ def __init__(self, api_client=None): 'application/json', 'application/vnd.gooddata.api+json' ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] + 'content_type': [], }, api_client=api_client ) - self.create_entity_memory_items_endpoint = _Endpoint( + self.get_entity_memory_items_endpoint = _Endpoint( settings={ 'response_type': (JsonApiMemoryItemOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/memoryItems', - 'operation_id': 'create_entity_memory_items', - 'http_method': 'POST', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}', + 'operation_id': 'get_entity_memory_items', + 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ 'workspace_id', - 'json_api_memory_item_post_optional_id_document', + 'object_id', + 'filter', 'include', + 'x_gdc_validate_relations', 'meta_include', ], 'required': [ 'workspace_id', - 'json_api_memory_item_post_optional_id_document', + 'object_id', ], 'nullable': [ ], @@ -977,22 +958,31 @@ def __init__(self, api_client=None): 'openapi_types': { 'workspace_id': (str,), - 'json_api_memory_item_post_optional_id_document': - (JsonApiMemoryItemPostOptionalIdDocument,), + 'object_id': + (str,), + 'filter': + (str,), 'include': ([str],), + 'x_gdc_validate_relations': + (bool,), 'meta_include': ([str],), }, 'attribute_map': { 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', 'include': 'include', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', 'meta_include': 'metaInclude', }, 'location_map': { 'workspace_id': 'path', - 'json_api_memory_item_post_optional_id_document': 'body', + 'object_id': 'path', + 'filter': 'query', 'include': 'query', + 'x_gdc_validate_relations': 'header', 'meta_include': 'query', }, 'collection_format_map': { @@ -1005,94 +995,80 @@ def __init__(self, api_client=None): 'application/json', 'application/vnd.gooddata.api+json' ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] + 'content_type': [], }, api_client=api_client ) - self.create_entity_metrics_endpoint = _Endpoint( + self.patch_entity_knowledge_recommendations_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiMetricOutDocument,), + 'response_type': (JsonApiKnowledgeRecommendationOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/metrics', - 'operation_id': 'create_entity_metrics', - 'http_method': 'POST', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}', + 'operation_id': 'patch_entity_knowledge_recommendations', + 'http_method': 'PATCH', 'servers': None, }, params_map={ 'all': [ 'workspace_id', - 'json_api_metric_post_optional_id_document', + 'object_id', + 'json_api_knowledge_recommendation_patch_document', + 'filter', 'include', - 'meta_include', ], 'required': [ 'workspace_id', - 'json_api_metric_post_optional_id_document', + 'object_id', + 'json_api_knowledge_recommendation_patch_document', ], 'nullable': [ ], 'enum': [ 'include', - 'meta_include', ], 'validation': [ - 'meta_include', ] }, root_map={ 'validations': { - ('meta_include',): { - - }, }, 'allowed_values': { ('include',): { - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "CERTIFIEDBY": "certifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", + "ANALYTICALDASHBOARDS": "analyticalDashboards", + "METRIC": "metric", + "ANALYTICALDASHBOARD": "analyticalDashboard", "ALL": "ALL" }, }, 'openapi_types': { 'workspace_id': (str,), - 'json_api_metric_post_optional_id_document': - (JsonApiMetricPostOptionalIdDocument,), + 'object_id': + (str,), + 'json_api_knowledge_recommendation_patch_document': + (JsonApiKnowledgeRecommendationPatchDocument,), + 'filter': + (str,), 'include': ([str],), - 'meta_include': - ([str],), }, 'attribute_map': { 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', 'include': 'include', - 'meta_include': 'metaInclude', }, 'location_map': { 'workspace_id': 'path', - 'json_api_metric_post_optional_id_document': 'body', + 'object_id': 'path', + 'json_api_knowledge_recommendation_patch_document': 'body', + 'filter': 'query', 'include': 'query', - 'meta_include': 'query', }, 'collection_format_map': { 'include': 'csv', - 'meta_include': 'csv', } }, headers_map={ @@ -1107,87 +1083,75 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.create_entity_user_data_filters_endpoint = _Endpoint( + self.patch_entity_memory_items_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiUserDataFilterOutDocument,), + 'response_type': (JsonApiMemoryItemOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters', - 'operation_id': 'create_entity_user_data_filters', - 'http_method': 'POST', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}', + 'operation_id': 'patch_entity_memory_items', + 'http_method': 'PATCH', 'servers': None, }, params_map={ 'all': [ 'workspace_id', - 'json_api_user_data_filter_post_optional_id_document', + 'object_id', + 'json_api_memory_item_patch_document', + 'filter', 'include', - 'meta_include', ], 'required': [ 'workspace_id', - 'json_api_user_data_filter_post_optional_id_document', + 'object_id', + 'json_api_memory_item_patch_document', ], 'nullable': [ ], 'enum': [ 'include', - 'meta_include', ], 'validation': [ - 'meta_include', ] }, root_map={ 'validations': { - ('meta_include',): { - - }, }, 'allowed_values': { ('include',): { - "USERS": "users", - "USERGROUPS": "userGroups", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "USER": "user", - "USERGROUP": "userGroup", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", "ALL": "ALL" }, }, 'openapi_types': { 'workspace_id': (str,), - 'json_api_user_data_filter_post_optional_id_document': - (JsonApiUserDataFilterPostOptionalIdDocument,), + 'object_id': + (str,), + 'json_api_memory_item_patch_document': + (JsonApiMemoryItemPatchDocument,), + 'filter': + (str,), 'include': ([str],), - 'meta_include': - ([str],), }, 'attribute_map': { 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', 'include': 'include', - 'meta_include': 'metaInclude', }, 'location_map': { 'workspace_id': 'path', - 'json_api_user_data_filter_post_optional_id_document': 'body', + 'object_id': 'path', + 'json_api_memory_item_patch_document': 'body', + 'filter': 'query', 'include': 'query', - 'meta_include': 'query', }, 'collection_format_map': { 'include': 'csv', - 'meta_include': 'csv', } }, headers_map={ @@ -1202,87 +1166,67 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.create_entity_visualization_objects_endpoint = _Endpoint( + self.search_entities_aggregated_facts_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiVisualizationObjectOutDocument,), + 'response_type': (JsonApiAggregatedFactOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects', - 'operation_id': 'create_entity_visualization_objects', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/search', + 'operation_id': 'search_entities_aggregated_facts', 'http_method': 'POST', 'servers': None, }, params_map={ 'all': [ 'workspace_id', - 'json_api_visualization_object_post_optional_id_document', - 'include', - 'meta_include', + 'entity_search_body', + 'origin', + 'x_gdc_validate_relations', ], 'required': [ 'workspace_id', - 'json_api_visualization_object_post_optional_id_document', + 'entity_search_body', ], 'nullable': [ ], 'enum': [ - 'include', - 'meta_include', + 'origin', ], 'validation': [ - 'meta_include', ] }, root_map={ 'validations': { - ('meta_include',): { - - }, }, 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "CERTIFIEDBY": "certifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { + ('origin',): { - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" }, }, 'openapi_types': { 'workspace_id': (str,), - 'json_api_visualization_object_post_optional_id_document': - (JsonApiVisualizationObjectPostOptionalIdDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), + 'entity_search_body': + (EntitySearchBody,), + 'origin': + (str,), + 'x_gdc_validate_relations': + (bool,), }, 'attribute_map': { 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', + 'origin': 'origin', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', }, 'location_map': { 'workspace_id': 'path', - 'json_api_visualization_object_post_optional_id_document': 'body', - 'include': 'query', - 'meta_include': 'query', + 'entity_search_body': 'body', + 'origin': 'query', + 'x_gdc_validate_relations': 'header', }, 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', } }, headers_map={ @@ -1291,86 +1235,72 @@ def __init__(self, api_client=None): 'application/vnd.gooddata.api+json' ], 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' + 'application/json' ] }, api_client=api_client ) - self.create_entity_workspace_data_filter_settings_endpoint = _Endpoint( + self.search_entities_automation_results_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiWorkspaceDataFilterSettingOutDocument,), + 'response_type': (JsonApiAutomationResultOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings', - 'operation_id': 'create_entity_workspace_data_filter_settings', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automationResults/search', + 'operation_id': 'search_entities_automation_results', 'http_method': 'POST', 'servers': None, }, params_map={ 'all': [ 'workspace_id', - 'json_api_workspace_data_filter_setting_in_document', - 'include', - 'meta_include', + 'entity_search_body', + 'origin', + 'x_gdc_validate_relations', ], 'required': [ 'workspace_id', - 'json_api_workspace_data_filter_setting_in_document', + 'entity_search_body', ], 'nullable': [ ], 'enum': [ - 'include', - 'meta_include', + 'origin', ], 'validation': [ - 'meta_include', ] }, root_map={ 'validations': { - ('meta_include',): { - - }, }, 'allowed_values': { - ('include',): { - - "WORKSPACEDATAFILTERS": "workspaceDataFilters", - "WORKSPACEDATAFILTER": "workspaceDataFilter", - "ALL": "ALL" - }, - ('meta_include',): { + ('origin',): { - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" }, }, 'openapi_types': { 'workspace_id': (str,), - 'json_api_workspace_data_filter_setting_in_document': - (JsonApiWorkspaceDataFilterSettingInDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), + 'entity_search_body': + (EntitySearchBody,), + 'origin': + (str,), + 'x_gdc_validate_relations': + (bool,), }, 'attribute_map': { 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', + 'origin': 'origin', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', }, 'location_map': { 'workspace_id': 'path', - 'json_api_workspace_data_filter_setting_in_document': 'body', - 'include': 'query', - 'meta_include': 'query', + 'entity_search_body': 'body', + 'origin': 'query', + 'x_gdc_validate_relations': 'header', }, 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', } }, headers_map={ @@ -1379,86 +1309,72 @@ def __init__(self, api_client=None): 'application/vnd.gooddata.api+json' ], 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' + 'application/json' ] }, api_client=api_client ) - self.create_entity_workspace_data_filters_endpoint = _Endpoint( + self.search_entities_knowledge_recommendations_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiWorkspaceDataFilterOutDocument,), + 'response_type': (JsonApiKnowledgeRecommendationOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters', - 'operation_id': 'create_entity_workspace_data_filters', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search', + 'operation_id': 'search_entities_knowledge_recommendations', 'http_method': 'POST', 'servers': None, }, params_map={ 'all': [ 'workspace_id', - 'json_api_workspace_data_filter_in_document', - 'include', - 'meta_include', + 'entity_search_body', + 'origin', + 'x_gdc_validate_relations', ], 'required': [ 'workspace_id', - 'json_api_workspace_data_filter_in_document', + 'entity_search_body', ], 'nullable': [ ], 'enum': [ - 'include', - 'meta_include', + 'origin', ], 'validation': [ - 'meta_include', ] }, root_map={ 'validations': { - ('meta_include',): { - - }, }, 'allowed_values': { - ('include',): { - - "WORKSPACEDATAFILTERSETTINGS": "workspaceDataFilterSettings", - "FILTERSETTINGS": "filterSettings", - "ALL": "ALL" - }, - ('meta_include',): { + ('origin',): { - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" }, }, 'openapi_types': { 'workspace_id': (str,), - 'json_api_workspace_data_filter_in_document': - (JsonApiWorkspaceDataFilterInDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), + 'entity_search_body': + (EntitySearchBody,), + 'origin': + (str,), + 'x_gdc_validate_relations': + (bool,), }, 'attribute_map': { 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', + 'origin': 'origin', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', }, 'location_map': { 'workspace_id': 'path', - 'json_api_workspace_data_filter_in_document': 'body', - 'include': 'query', - 'meta_include': 'query', + 'entity_search_body': 'body', + 'origin': 'query', + 'x_gdc_validate_relations': 'header', }, 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', } }, headers_map={ @@ -1467,73 +1383,72 @@ def __init__(self, api_client=None): 'application/vnd.gooddata.api+json' ], 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' + 'application/json' ] }, api_client=api_client ) - self.create_entity_workspace_settings_endpoint = _Endpoint( + self.search_entities_memory_items_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiWorkspaceSettingOutDocument,), + 'response_type': (JsonApiMemoryItemOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings', - 'operation_id': 'create_entity_workspace_settings', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/memoryItems/search', + 'operation_id': 'search_entities_memory_items', 'http_method': 'POST', 'servers': None, }, params_map={ 'all': [ 'workspace_id', - 'json_api_workspace_setting_post_optional_id_document', - 'meta_include', + 'entity_search_body', + 'origin', + 'x_gdc_validate_relations', ], 'required': [ 'workspace_id', - 'json_api_workspace_setting_post_optional_id_document', + 'entity_search_body', ], 'nullable': [ ], 'enum': [ - 'meta_include', + 'origin', ], 'validation': [ - 'meta_include', ] }, root_map={ 'validations': { - ('meta_include',): { - - }, }, 'allowed_values': { - ('meta_include',): { + ('origin',): { - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" }, }, 'openapi_types': { 'workspace_id': (str,), - 'json_api_workspace_setting_post_optional_id_document': - (JsonApiWorkspaceSettingPostOptionalIdDocument,), - 'meta_include': - ([str],), + 'entity_search_body': + (EntitySearchBody,), + 'origin': + (str,), + 'x_gdc_validate_relations': + (bool,), }, 'attribute_map': { 'workspace_id': 'workspaceId', - 'meta_include': 'metaInclude', + 'origin': 'origin', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', }, 'location_map': { 'workspace_id': 'path', - 'json_api_workspace_setting_post_optional_id_document': 'body', - 'meta_include': 'query', + 'entity_search_body': 'body', + 'origin': 'query', + 'x_gdc_validate_relations': 'header', }, 'collection_format_map': { - 'meta_include': 'csv', } }, headers_map={ @@ -1542,34 +1457,37 @@ def __init__(self, api_client=None): 'application/vnd.gooddata.api+json' ], 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' + 'application/json' ] }, api_client=api_client ) - self.delete_entity_analytical_dashboards_endpoint = _Endpoint( + self.update_entity_knowledge_recommendations_endpoint = _Endpoint( settings={ - 'response_type': None, + 'response_type': (JsonApiKnowledgeRecommendationOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}', - 'operation_id': 'delete_entity_analytical_dashboards', - 'http_method': 'DELETE', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}', + 'operation_id': 'update_entity_knowledge_recommendations', + 'http_method': 'PUT', 'servers': None, }, params_map={ 'all': [ 'workspace_id', 'object_id', + 'json_api_knowledge_recommendation_in_document', 'filter', + 'include', ], 'required': [ 'workspace_id', 'object_id', + 'json_api_knowledge_recommendation_in_document', ], 'nullable': [ ], 'enum': [ + 'include', ], 'validation': [ ] @@ -1578,288 +1496,82 @@ def __init__(self, api_client=None): 'validations': { }, 'allowed_values': { + ('include',): { + + "METRICS": "metrics", + "ANALYTICALDASHBOARDS": "analyticalDashboards", + "METRIC": "metric", + "ANALYTICALDASHBOARD": "analyticalDashboard", + "ALL": "ALL" + }, }, 'openapi_types': { 'workspace_id': (str,), 'object_id': (str,), + 'json_api_knowledge_recommendation_in_document': + (JsonApiKnowledgeRecommendationInDocument,), 'filter': (str,), + 'include': + ([str],), }, 'attribute_map': { 'workspace_id': 'workspaceId', 'object_id': 'objectId', 'filter': 'filter', + 'include': 'include', }, 'location_map': { 'workspace_id': 'path', 'object_id': 'path', + 'json_api_knowledge_recommendation_in_document': 'body', 'filter': 'query', + 'include': 'query', }, 'collection_format_map': { + 'include': 'csv', } }, headers_map={ - 'accept': [], - 'content_type': [], + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] }, api_client=api_client ) - self.delete_entity_attribute_hierarchies_endpoint = _Endpoint( + self.update_entity_memory_items_endpoint = _Endpoint( settings={ - 'response_type': None, + 'response_type': (JsonApiMemoryItemOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}', - 'operation_id': 'delete_entity_attribute_hierarchies', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_automations_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}', - 'operation_id': 'delete_entity_automations', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_custom_application_settings_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', - 'operation_id': 'delete_entity_custom_application_settings', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_dashboard_plugins_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', - 'operation_id': 'delete_entity_dashboard_plugins', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_export_definitions_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', - 'operation_id': 'delete_entity_export_definitions', - 'http_method': 'DELETE', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}', + 'operation_id': 'update_entity_memory_items', + 'http_method': 'PUT', 'servers': None, }, params_map={ 'all': [ 'workspace_id', 'object_id', + 'json_api_memory_item_in_document', 'filter', + 'include', ], 'required': [ 'workspace_id', 'object_id', + 'json_api_memory_item_in_document', ], 'nullable': [ ], 'enum': [ + 'include', ], 'validation': [ ] @@ -1868,20028 +1580,77 @@ def __init__(self, api_client=None): 'validations': { }, 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, }, 'openapi_types': { 'workspace_id': (str,), 'object_id': (str,), + 'json_api_memory_item_in_document': + (JsonApiMemoryItemInDocument,), 'filter': (str,), + 'include': + ([str],), }, 'attribute_map': { 'workspace_id': 'workspaceId', 'object_id': 'objectId', 'filter': 'filter', + 'include': 'include', }, 'location_map': { 'workspace_id': 'path', 'object_id': 'path', + 'json_api_memory_item_in_document': 'body', 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_filter_contexts_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', - 'operation_id': 'delete_entity_filter_contexts', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_filter_views_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', - 'operation_id': 'delete_entity_filter_views', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_knowledge_recommendations_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}', - 'operation_id': 'delete_entity_knowledge_recommendations', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_memory_items_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}', - 'operation_id': 'delete_entity_memory_items', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_metrics_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}', - 'operation_id': 'delete_entity_metrics', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_user_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', - 'operation_id': 'delete_entity_user_data_filters', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_visualization_objects_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', - 'operation_id': 'delete_entity_visualization_objects', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_workspace_data_filter_settings_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', - 'operation_id': 'delete_entity_workspace_data_filter_settings', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_workspace_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', - 'operation_id': 'delete_entity_workspace_data_filters', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_workspace_settings_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', - 'operation_id': 'delete_entity_workspace_settings', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_aggregated_facts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAggregatedFactOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts', - 'operation_id': 'get_all_entities_aggregated_facts', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "DATASETS": "datasets", - "FACTS": "facts", - "DATASET": "dataset", - "SOURCEFACT": "sourceFact", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_analytical_dashboards_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAnalyticalDashboardOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards', - 'operation_id': 'get_all_entities_analytical_dashboards', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "FILTERCONTEXTS": "filterContexts", - "DASHBOARDPLUGINS": "dashboardPlugins", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "CERTIFIEDBY": "certifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "PERMISSIONS": "permissions", - "ORIGIN": "origin", - "ACCESSINFO": "accessInfo", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_attribute_hierarchies_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAttributeHierarchyOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies', - 'operation_id': 'get_all_entities_attribute_hierarchies', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "ATTRIBUTES": "attributes", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_attributes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAttributeOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributes', - 'operation_id': 'get_all_entities_attributes', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "DATASETS": "datasets", - "LABELS": "labels", - "ATTRIBUTEHIERARCHIES": "attributeHierarchies", - "DATASET": "dataset", - "DEFAULTVIEW": "defaultView", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_automations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAutomationOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automations', - 'operation_id': 'get_all_entities_automations', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "NOTIFICATIONCHANNELS": "notificationChannels", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERIDENTIFIERS": "userIdentifiers", - "EXPORTDEFINITIONS": "exportDefinitions", - "USERS": "users", - "AUTOMATIONRESULTS": "automationResults", - "NOTIFICATIONCHANNEL": "notificationChannel", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "RECIPIENTS": "recipients", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_custom_application_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCustomApplicationSettingOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings', - 'operation_id': 'get_all_entities_custom_application_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_dashboard_plugins_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDashboardPluginOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins', - 'operation_id': 'get_all_entities_dashboard_plugins', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_datasets_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDatasetOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/datasets', - 'operation_id': 'get_all_entities_datasets', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "ATTRIBUTES": "attributes", - "FACTS": "facts", - "AGGREGATEDFACTS": "aggregatedFacts", - "DATASETS": "datasets", - "WORKSPACEDATAFILTERS": "workspaceDataFilters", - "REFERENCES": "references", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_export_definitions_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportDefinitionOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions', - 'operation_id': 'get_all_entities_export_definitions', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "AUTOMATIONS": "automations", - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECT": "visualizationObject", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "AUTOMATION": "automation", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_facts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFactOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/facts', - 'operation_id': 'get_all_entities_facts', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "DATASETS": "datasets", - "DATASET": "dataset", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_filter_contexts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterContextOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts', - 'operation_id': 'get_all_entities_filter_contexts', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "ATTRIBUTES": "attributes", - "DATASETS": "datasets", - "LABELS": "labels", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_filter_views_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterViewOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews', - 'operation_id': 'get_all_entities_filter_views', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERS": "users", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "USER": "user", - "ALL": "ALL" - }, - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_knowledge_recommendations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiKnowledgeRecommendationOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations', - 'operation_id': 'get_all_entities_knowledge_recommendations', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "METRICS": "metrics", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "METRIC": "metric", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_labels_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiLabelOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/labels', - 'operation_id': 'get_all_entities_labels', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "ATTRIBUTES": "attributes", - "ATTRIBUTE": "attribute", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_memory_items_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiMemoryItemOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/memoryItems', - 'operation_id': 'get_all_entities_memory_items', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_metrics_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiMetricOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/metrics', - 'operation_id': 'get_all_entities_metrics', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "CERTIFIEDBY": "certifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_user_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserDataFilterOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters', - 'operation_id': 'get_all_entities_user_data_filters', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "USERS": "users", - "USERGROUPS": "userGroups", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "USER": "user", - "USERGROUP": "userGroup", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_visualization_objects_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiVisualizationObjectOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects', - 'operation_id': 'get_all_entities_visualization_objects', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "CERTIFIEDBY": "certifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_workspace_data_filter_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterSettingOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings', - 'operation_id': 'get_all_entities_workspace_data_filter_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "WORKSPACEDATAFILTERS": "workspaceDataFilters", - "WORKSPACEDATAFILTER": "workspaceDataFilter", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_workspace_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters', - 'operation_id': 'get_all_entities_workspace_data_filters', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "WORKSPACEDATAFILTERSETTINGS": "workspaceDataFilterSettings", - "FILTERSETTINGS": "filterSettings", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_workspace_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceSettingOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings', - 'operation_id': 'get_all_entities_workspace_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'origin', - 'filter', - 'page', - 'size', - 'sort', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'origin': 'query', - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_aggregated_facts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAggregatedFactOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/{objectId}', - 'operation_id': 'get_entity_aggregated_facts', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "DATASETS": "datasets", - "FACTS": "facts", - "DATASET": "dataset", - "SOURCEFACT": "sourceFact", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_analytical_dashboards_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAnalyticalDashboardOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}', - 'operation_id': 'get_entity_analytical_dashboards', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "FILTERCONTEXTS": "filterContexts", - "DASHBOARDPLUGINS": "dashboardPlugins", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "CERTIFIEDBY": "certifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "PERMISSIONS": "permissions", - "ORIGIN": "origin", - "ACCESSINFO": "accessInfo", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_attribute_hierarchies_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAttributeHierarchyOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}', - 'operation_id': 'get_entity_attribute_hierarchies', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "ATTRIBUTES": "attributes", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_attributes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAttributeOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributes/{objectId}', - 'operation_id': 'get_entity_attributes', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "DATASETS": "datasets", - "LABELS": "labels", - "ATTRIBUTEHIERARCHIES": "attributeHierarchies", - "DATASET": "dataset", - "DEFAULTVIEW": "defaultView", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_automations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAutomationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}', - 'operation_id': 'get_entity_automations', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "NOTIFICATIONCHANNELS": "notificationChannels", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERIDENTIFIERS": "userIdentifiers", - "EXPORTDEFINITIONS": "exportDefinitions", - "USERS": "users", - "AUTOMATIONRESULTS": "automationResults", - "NOTIFICATIONCHANNEL": "notificationChannel", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "RECIPIENTS": "recipients", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_custom_application_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCustomApplicationSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', - 'operation_id': 'get_entity_custom_application_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_dashboard_plugins_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDashboardPluginOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', - 'operation_id': 'get_entity_dashboard_plugins', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_datasets_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDatasetOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/datasets/{objectId}', - 'operation_id': 'get_entity_datasets', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "ATTRIBUTES": "attributes", - "FACTS": "facts", - "AGGREGATEDFACTS": "aggregatedFacts", - "DATASETS": "datasets", - "WORKSPACEDATAFILTERS": "workspaceDataFilters", - "REFERENCES": "references", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_export_definitions_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportDefinitionOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', - 'operation_id': 'get_entity_export_definitions', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "AUTOMATIONS": "automations", - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECT": "visualizationObject", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "AUTOMATION": "automation", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_facts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFactOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/facts/{objectId}', - 'operation_id': 'get_entity_facts', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "DATASETS": "datasets", - "DATASET": "dataset", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_filter_contexts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterContextOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', - 'operation_id': 'get_entity_filter_contexts', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "ATTRIBUTES": "attributes", - "DATASETS": "datasets", - "LABELS": "labels", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_filter_views_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterViewOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', - 'operation_id': 'get_entity_filter_views', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERS": "users", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "USER": "user", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_knowledge_recommendations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiKnowledgeRecommendationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}', - 'operation_id': 'get_entity_knowledge_recommendations', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "METRICS": "metrics", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "METRIC": "metric", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_labels_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiLabelOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/labels/{objectId}', - 'operation_id': 'get_entity_labels', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "ATTRIBUTES": "attributes", - "ATTRIBUTE": "attribute", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_memory_items_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiMemoryItemOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}', - 'operation_id': 'get_entity_memory_items', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_metrics_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiMetricOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}', - 'operation_id': 'get_entity_metrics', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "CERTIFIEDBY": "certifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_user_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserDataFilterOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', - 'operation_id': 'get_entity_user_data_filters', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERS": "users", - "USERGROUPS": "userGroups", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "USER": "user", - "USERGROUP": "userGroup", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_visualization_objects_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiVisualizationObjectOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', - 'operation_id': 'get_entity_visualization_objects', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "CERTIFIEDBY": "certifiedBy", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_workspace_data_filter_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', - 'operation_id': 'get_entity_workspace_data_filter_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "WORKSPACEDATAFILTERS": "workspaceDataFilters", - "WORKSPACEDATAFILTER": "workspaceDataFilter", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_workspace_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', - 'operation_id': 'get_entity_workspace_data_filters', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "WORKSPACEDATAFILTERSETTINGS": "workspaceDataFilterSettings", - "FILTERSETTINGS": "filterSettings", - "ALL": "ALL" - }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_workspace_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', - 'operation_id': 'get_entity_workspace_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'filter': - (str,), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'filter': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.patch_entity_analytical_dashboards_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAnalyticalDashboardOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}', - 'operation_id': 'patch_entity_analytical_dashboards', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_analytical_dashboard_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_analytical_dashboard_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "FILTERCONTEXTS": "filterContexts", - "DASHBOARDPLUGINS": "dashboardPlugins", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "CERTIFIEDBY": "certifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_analytical_dashboard_patch_document': - (JsonApiAnalyticalDashboardPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_analytical_dashboard_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_attribute_hierarchies_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAttributeHierarchyOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}', - 'operation_id': 'patch_entity_attribute_hierarchies', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_attribute_hierarchy_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_attribute_hierarchy_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "ATTRIBUTES": "attributes", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_attribute_hierarchy_patch_document': - (JsonApiAttributeHierarchyPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_attribute_hierarchy_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_attributes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAttributeOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributes/{objectId}', - 'operation_id': 'patch_entity_attributes', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_attribute_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_attribute_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "DATASETS": "datasets", - "LABELS": "labels", - "ATTRIBUTEHIERARCHIES": "attributeHierarchies", - "DATASET": "dataset", - "DEFAULTVIEW": "defaultView", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_attribute_patch_document': - (JsonApiAttributePatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_attribute_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_automations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAutomationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}', - 'operation_id': 'patch_entity_automations', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_automation_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_automation_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "NOTIFICATIONCHANNELS": "notificationChannels", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERIDENTIFIERS": "userIdentifiers", - "EXPORTDEFINITIONS": "exportDefinitions", - "USERS": "users", - "AUTOMATIONRESULTS": "automationResults", - "NOTIFICATIONCHANNEL": "notificationChannel", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "RECIPIENTS": "recipients", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_automation_patch_document': - (JsonApiAutomationPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_automation_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_custom_application_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCustomApplicationSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', - 'operation_id': 'patch_entity_custom_application_settings', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_custom_application_setting_patch_document', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_custom_application_setting_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_custom_application_setting_patch_document': - (JsonApiCustomApplicationSettingPatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_custom_application_setting_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_dashboard_plugins_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDashboardPluginOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', - 'operation_id': 'patch_entity_dashboard_plugins', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_dashboard_plugin_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_dashboard_plugin_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_dashboard_plugin_patch_document': - (JsonApiDashboardPluginPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_dashboard_plugin_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_datasets_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDatasetOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/datasets/{objectId}', - 'operation_id': 'patch_entity_datasets', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_dataset_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_dataset_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "ATTRIBUTES": "attributes", - "FACTS": "facts", - "AGGREGATEDFACTS": "aggregatedFacts", - "DATASETS": "datasets", - "WORKSPACEDATAFILTERS": "workspaceDataFilters", - "REFERENCES": "references", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_dataset_patch_document': - (JsonApiDatasetPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_dataset_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_export_definitions_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportDefinitionOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', - 'operation_id': 'patch_entity_export_definitions', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_export_definition_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_export_definition_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "AUTOMATIONS": "automations", - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECT": "visualizationObject", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "AUTOMATION": "automation", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_export_definition_patch_document': - (JsonApiExportDefinitionPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_export_definition_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_facts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFactOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/facts/{objectId}', - 'operation_id': 'patch_entity_facts', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_fact_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_fact_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "DATASETS": "datasets", - "DATASET": "dataset", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_fact_patch_document': - (JsonApiFactPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_fact_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_filter_contexts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterContextOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', - 'operation_id': 'patch_entity_filter_contexts', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_filter_context_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_filter_context_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "ATTRIBUTES": "attributes", - "DATASETS": "datasets", - "LABELS": "labels", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_filter_context_patch_document': - (JsonApiFilterContextPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_filter_context_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_filter_views_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterViewOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', - 'operation_id': 'patch_entity_filter_views', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_filter_view_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_filter_view_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERS": "users", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "USER": "user", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_filter_view_patch_document': - (JsonApiFilterViewPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_filter_view_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_knowledge_recommendations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiKnowledgeRecommendationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}', - 'operation_id': 'patch_entity_knowledge_recommendations', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_knowledge_recommendation_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_knowledge_recommendation_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "METRICS": "metrics", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "METRIC": "metric", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_knowledge_recommendation_patch_document': - (JsonApiKnowledgeRecommendationPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_knowledge_recommendation_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_labels_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiLabelOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/labels/{objectId}', - 'operation_id': 'patch_entity_labels', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_label_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_label_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "ATTRIBUTES": "attributes", - "ATTRIBUTE": "attribute", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_label_patch_document': - (JsonApiLabelPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_label_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_memory_items_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiMemoryItemOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}', - 'operation_id': 'patch_entity_memory_items', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_memory_item_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_memory_item_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_memory_item_patch_document': - (JsonApiMemoryItemPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_memory_item_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_metrics_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiMetricOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}', - 'operation_id': 'patch_entity_metrics', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_metric_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_metric_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "CERTIFIEDBY": "certifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_metric_patch_document': - (JsonApiMetricPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_metric_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_user_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserDataFilterOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', - 'operation_id': 'patch_entity_user_data_filters', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_user_data_filter_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_user_data_filter_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERS": "users", - "USERGROUPS": "userGroups", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "USER": "user", - "USERGROUP": "userGroup", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_user_data_filter_patch_document': - (JsonApiUserDataFilterPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_user_data_filter_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_visualization_objects_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiVisualizationObjectOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', - 'operation_id': 'patch_entity_visualization_objects', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_visualization_object_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_visualization_object_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "CERTIFIEDBY": "certifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_visualization_object_patch_document': - (JsonApiVisualizationObjectPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_visualization_object_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_workspace_data_filter_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', - 'operation_id': 'patch_entity_workspace_data_filter_settings', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_data_filter_setting_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_data_filter_setting_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "WORKSPACEDATAFILTERS": "workspaceDataFilters", - "WORKSPACEDATAFILTER": "workspaceDataFilter", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_workspace_data_filter_setting_patch_document': - (JsonApiWorkspaceDataFilterSettingPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_workspace_data_filter_setting_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_workspace_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', - 'operation_id': 'patch_entity_workspace_data_filters', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_data_filter_patch_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_data_filter_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "WORKSPACEDATAFILTERSETTINGS": "workspaceDataFilterSettings", - "FILTERSETTINGS": "filterSettings", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_workspace_data_filter_patch_document': - (JsonApiWorkspaceDataFilterPatchDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_workspace_data_filter_patch_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.patch_entity_workspace_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', - 'operation_id': 'patch_entity_workspace_settings', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_setting_patch_document', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_setting_patch_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_workspace_setting_patch_document': - (JsonApiWorkspaceSettingPatchDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_workspace_setting_patch_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.search_entities_aggregated_facts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAggregatedFactOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/search', - 'operation_id': 'search_entities_aggregated_facts', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'entity_search_body', - 'origin', - 'x_gdc_validate_relations', - ], - 'required': [ - 'workspace_id', - 'entity_search_body', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'entity_search_body': - (EntitySearchBody,), - 'origin': - (str,), - 'x_gdc_validate_relations': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - }, - 'location_map': { - 'workspace_id': 'path', - 'entity_search_body': 'body', - 'origin': 'query', - 'x_gdc_validate_relations': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.search_entities_analytical_dashboards_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAnalyticalDashboardOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search', - 'operation_id': 'search_entities_analytical_dashboards', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'entity_search_body', - 'origin', - 'x_gdc_validate_relations', - ], - 'required': [ - 'workspace_id', - 'entity_search_body', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'entity_search_body': - (EntitySearchBody,), - 'origin': - (str,), - 'x_gdc_validate_relations': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - }, - 'location_map': { - 'workspace_id': 'path', - 'entity_search_body': 'body', - 'origin': 'query', - 'x_gdc_validate_relations': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.search_entities_attribute_hierarchies_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAttributeHierarchyOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search', - 'operation_id': 'search_entities_attribute_hierarchies', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'entity_search_body', - 'origin', - 'x_gdc_validate_relations', - ], - 'required': [ - 'workspace_id', - 'entity_search_body', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'entity_search_body': - (EntitySearchBody,), - 'origin': - (str,), - 'x_gdc_validate_relations': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - }, - 'location_map': { - 'workspace_id': 'path', - 'entity_search_body': 'body', - 'origin': 'query', - 'x_gdc_validate_relations': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.search_entities_attributes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAttributeOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributes/search', - 'operation_id': 'search_entities_attributes', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'entity_search_body', - 'origin', - 'x_gdc_validate_relations', - ], - 'required': [ - 'workspace_id', - 'entity_search_body', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'entity_search_body': - (EntitySearchBody,), - 'origin': - (str,), - 'x_gdc_validate_relations': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - }, - 'location_map': { - 'workspace_id': 'path', - 'entity_search_body': 'body', - 'origin': 'query', - 'x_gdc_validate_relations': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.search_entities_automation_results_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAutomationResultOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automationResults/search', - 'operation_id': 'search_entities_automation_results', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'entity_search_body', - 'origin', - 'x_gdc_validate_relations', - ], - 'required': [ - 'workspace_id', - 'entity_search_body', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'entity_search_body': - (EntitySearchBody,), - 'origin': - (str,), - 'x_gdc_validate_relations': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - }, - 'location_map': { - 'workspace_id': 'path', - 'entity_search_body': 'body', - 'origin': 'query', - 'x_gdc_validate_relations': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.search_entities_automations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAutomationOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automations/search', - 'operation_id': 'search_entities_automations', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'entity_search_body', - 'origin', - 'x_gdc_validate_relations', - ], - 'required': [ - 'workspace_id', - 'entity_search_body', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'entity_search_body': - (EntitySearchBody,), - 'origin': - (str,), - 'x_gdc_validate_relations': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - }, - 'location_map': { - 'workspace_id': 'path', - 'entity_search_body': 'body', - 'origin': 'query', - 'x_gdc_validate_relations': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.search_entities_custom_application_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCustomApplicationSettingOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search', - 'operation_id': 'search_entities_custom_application_settings', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'entity_search_body', - 'origin', - 'x_gdc_validate_relations', - ], - 'required': [ - 'workspace_id', - 'entity_search_body', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'entity_search_body': - (EntitySearchBody,), - 'origin': - (str,), - 'x_gdc_validate_relations': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - }, - 'location_map': { - 'workspace_id': 'path', - 'entity_search_body': 'body', - 'origin': 'query', - 'x_gdc_validate_relations': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.search_entities_dashboard_plugins_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDashboardPluginOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search', - 'operation_id': 'search_entities_dashboard_plugins', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'entity_search_body', - 'origin', - 'x_gdc_validate_relations', - ], - 'required': [ - 'workspace_id', - 'entity_search_body', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'entity_search_body': - (EntitySearchBody,), - 'origin': - (str,), - 'x_gdc_validate_relations': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - }, - 'location_map': { - 'workspace_id': 'path', - 'entity_search_body': 'body', - 'origin': 'query', - 'x_gdc_validate_relations': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.search_entities_datasets_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDatasetOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/datasets/search', - 'operation_id': 'search_entities_datasets', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'entity_search_body', - 'origin', - 'x_gdc_validate_relations', - ], - 'required': [ - 'workspace_id', - 'entity_search_body', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'entity_search_body': - (EntitySearchBody,), - 'origin': - (str,), - 'x_gdc_validate_relations': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - }, - 'location_map': { - 'workspace_id': 'path', - 'entity_search_body': 'body', - 'origin': 'query', - 'x_gdc_validate_relations': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.search_entities_export_definitions_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportDefinitionOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/search', - 'operation_id': 'search_entities_export_definitions', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'entity_search_body', - 'origin', - 'x_gdc_validate_relations', - ], - 'required': [ - 'workspace_id', - 'entity_search_body', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'entity_search_body': - (EntitySearchBody,), - 'origin': - (str,), - 'x_gdc_validate_relations': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - }, - 'location_map': { - 'workspace_id': 'path', - 'entity_search_body': 'body', - 'origin': 'query', - 'x_gdc_validate_relations': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.search_entities_facts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFactOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/facts/search', - 'operation_id': 'search_entities_facts', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'entity_search_body', - 'origin', - 'x_gdc_validate_relations', - ], - 'required': [ - 'workspace_id', - 'entity_search_body', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'entity_search_body': - (EntitySearchBody,), - 'origin': - (str,), - 'x_gdc_validate_relations': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - }, - 'location_map': { - 'workspace_id': 'path', - 'entity_search_body': 'body', - 'origin': 'query', - 'x_gdc_validate_relations': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.search_entities_filter_contexts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterContextOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts/search', - 'operation_id': 'search_entities_filter_contexts', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'entity_search_body', - 'origin', - 'x_gdc_validate_relations', - ], - 'required': [ - 'workspace_id', - 'entity_search_body', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'entity_search_body': - (EntitySearchBody,), - 'origin': - (str,), - 'x_gdc_validate_relations': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - }, - 'location_map': { - 'workspace_id': 'path', - 'entity_search_body': 'body', - 'origin': 'query', - 'x_gdc_validate_relations': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.search_entities_filter_views_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterViewOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews/search', - 'operation_id': 'search_entities_filter_views', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'entity_search_body', - 'origin', - 'x_gdc_validate_relations', - ], - 'required': [ - 'workspace_id', - 'entity_search_body', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'entity_search_body': - (EntitySearchBody,), - 'origin': - (str,), - 'x_gdc_validate_relations': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - }, - 'location_map': { - 'workspace_id': 'path', - 'entity_search_body': 'body', - 'origin': 'query', - 'x_gdc_validate_relations': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.search_entities_knowledge_recommendations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiKnowledgeRecommendationOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search', - 'operation_id': 'search_entities_knowledge_recommendations', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'entity_search_body', - 'origin', - 'x_gdc_validate_relations', - ], - 'required': [ - 'workspace_id', - 'entity_search_body', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'entity_search_body': - (EntitySearchBody,), - 'origin': - (str,), - 'x_gdc_validate_relations': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - }, - 'location_map': { - 'workspace_id': 'path', - 'entity_search_body': 'body', - 'origin': 'query', - 'x_gdc_validate_relations': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.search_entities_labels_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiLabelOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/labels/search', - 'operation_id': 'search_entities_labels', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'entity_search_body', - 'origin', - 'x_gdc_validate_relations', - ], - 'required': [ - 'workspace_id', - 'entity_search_body', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'entity_search_body': - (EntitySearchBody,), - 'origin': - (str,), - 'x_gdc_validate_relations': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - }, - 'location_map': { - 'workspace_id': 'path', - 'entity_search_body': 'body', - 'origin': 'query', - 'x_gdc_validate_relations': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.search_entities_memory_items_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiMemoryItemOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/memoryItems/search', - 'operation_id': 'search_entities_memory_items', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'entity_search_body', - 'origin', - 'x_gdc_validate_relations', - ], - 'required': [ - 'workspace_id', - 'entity_search_body', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'entity_search_body': - (EntitySearchBody,), - 'origin': - (str,), - 'x_gdc_validate_relations': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - }, - 'location_map': { - 'workspace_id': 'path', - 'entity_search_body': 'body', - 'origin': 'query', - 'x_gdc_validate_relations': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.search_entities_metrics_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiMetricOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/metrics/search', - 'operation_id': 'search_entities_metrics', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'entity_search_body', - 'origin', - 'x_gdc_validate_relations', - ], - 'required': [ - 'workspace_id', - 'entity_search_body', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'entity_search_body': - (EntitySearchBody,), - 'origin': - (str,), - 'x_gdc_validate_relations': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - }, - 'location_map': { - 'workspace_id': 'path', - 'entity_search_body': 'body', - 'origin': 'query', - 'x_gdc_validate_relations': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.search_entities_user_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserDataFilterOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters/search', - 'operation_id': 'search_entities_user_data_filters', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'entity_search_body', - 'origin', - 'x_gdc_validate_relations', - ], - 'required': [ - 'workspace_id', - 'entity_search_body', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'entity_search_body': - (EntitySearchBody,), - 'origin': - (str,), - 'x_gdc_validate_relations': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - }, - 'location_map': { - 'workspace_id': 'path', - 'entity_search_body': 'body', - 'origin': 'query', - 'x_gdc_validate_relations': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.search_entities_visualization_objects_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiVisualizationObjectOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/search', - 'operation_id': 'search_entities_visualization_objects', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'entity_search_body', - 'origin', - 'x_gdc_validate_relations', - ], - 'required': [ - 'workspace_id', - 'entity_search_body', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'entity_search_body': - (EntitySearchBody,), - 'origin': - (str,), - 'x_gdc_validate_relations': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - }, - 'location_map': { - 'workspace_id': 'path', - 'entity_search_body': 'body', - 'origin': 'query', - 'x_gdc_validate_relations': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.search_entities_workspace_data_filter_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterSettingOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/search', - 'operation_id': 'search_entities_workspace_data_filter_settings', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'entity_search_body', - 'origin', - 'x_gdc_validate_relations', - ], - 'required': [ - 'workspace_id', - 'entity_search_body', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'entity_search_body': - (EntitySearchBody,), - 'origin': - (str,), - 'x_gdc_validate_relations': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - }, - 'location_map': { - 'workspace_id': 'path', - 'entity_search_body': 'body', - 'origin': 'query', - 'x_gdc_validate_relations': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.search_entities_workspace_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/search', - 'operation_id': 'search_entities_workspace_data_filters', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'entity_search_body', - 'origin', - 'x_gdc_validate_relations', - ], - 'required': [ - 'workspace_id', - 'entity_search_body', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'entity_search_body': - (EntitySearchBody,), - 'origin': - (str,), - 'x_gdc_validate_relations': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - }, - 'location_map': { - 'workspace_id': 'path', - 'entity_search_body': 'body', - 'origin': 'query', - 'x_gdc_validate_relations': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.search_entities_workspace_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceSettingOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/search', - 'operation_id': 'search_entities_workspace_settings', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'entity_search_body', - 'origin', - 'x_gdc_validate_relations', - ], - 'required': [ - 'workspace_id', - 'entity_search_body', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'entity_search_body': - (EntitySearchBody,), - 'origin': - (str,), - 'x_gdc_validate_relations': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - }, - 'location_map': { - 'workspace_id': 'path', - 'entity_search_body': 'body', - 'origin': 'query', - 'x_gdc_validate_relations': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.update_entity_analytical_dashboards_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAnalyticalDashboardOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}', - 'operation_id': 'update_entity_analytical_dashboards', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_analytical_dashboard_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_analytical_dashboard_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "FILTERCONTEXTS": "filterContexts", - "DASHBOARDPLUGINS": "dashboardPlugins", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "CERTIFIEDBY": "certifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_analytical_dashboard_in_document': - (JsonApiAnalyticalDashboardInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_analytical_dashboard_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_attribute_hierarchies_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAttributeHierarchyOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}', - 'operation_id': 'update_entity_attribute_hierarchies', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_attribute_hierarchy_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_attribute_hierarchy_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "ATTRIBUTES": "attributes", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_attribute_hierarchy_in_document': - (JsonApiAttributeHierarchyInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_attribute_hierarchy_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_automations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiAutomationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}', - 'operation_id': 'update_entity_automations', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_automation_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_automation_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "NOTIFICATIONCHANNELS": "notificationChannels", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERIDENTIFIERS": "userIdentifiers", - "EXPORTDEFINITIONS": "exportDefinitions", - "USERS": "users", - "AUTOMATIONRESULTS": "automationResults", - "NOTIFICATIONCHANNEL": "notificationChannel", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "RECIPIENTS": "recipients", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_automation_in_document': - (JsonApiAutomationInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_automation_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_custom_application_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCustomApplicationSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', - 'operation_id': 'update_entity_custom_application_settings', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_custom_application_setting_in_document', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_custom_application_setting_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_custom_application_setting_in_document': - (JsonApiCustomApplicationSettingInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_custom_application_setting_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_dashboard_plugins_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDashboardPluginOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', - 'operation_id': 'update_entity_dashboard_plugins', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_dashboard_plugin_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_dashboard_plugin_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_dashboard_plugin_in_document': - (JsonApiDashboardPluginInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_dashboard_plugin_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_export_definitions_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiExportDefinitionOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', - 'operation_id': 'update_entity_export_definitions', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_export_definition_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_export_definition_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "AUTOMATIONS": "automations", - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECT": "visualizationObject", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "AUTOMATION": "automation", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_export_definition_in_document': - (JsonApiExportDefinitionInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_export_definition_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_filter_contexts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterContextOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', - 'operation_id': 'update_entity_filter_contexts', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_filter_context_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_filter_context_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "ATTRIBUTES": "attributes", - "DATASETS": "datasets", - "LABELS": "labels", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_filter_context_in_document': - (JsonApiFilterContextInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_filter_context_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_filter_views_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiFilterViewOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', - 'operation_id': 'update_entity_filter_views', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_filter_view_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_filter_view_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERS": "users", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "USER": "user", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_filter_view_in_document': - (JsonApiFilterViewInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_filter_view_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_knowledge_recommendations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiKnowledgeRecommendationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}', - 'operation_id': 'update_entity_knowledge_recommendations', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_knowledge_recommendation_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_knowledge_recommendation_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "METRICS": "metrics", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "METRIC": "metric", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_knowledge_recommendation_in_document': - (JsonApiKnowledgeRecommendationInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_knowledge_recommendation_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_memory_items_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiMemoryItemOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}', - 'operation_id': 'update_entity_memory_items', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_memory_item_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_memory_item_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_memory_item_in_document': - (JsonApiMemoryItemInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_memory_item_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_metrics_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiMetricOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}', - 'operation_id': 'update_entity_metrics', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_metric_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_metric_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "CERTIFIEDBY": "certifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_metric_in_document': - (JsonApiMetricInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_metric_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_user_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserDataFilterOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', - 'operation_id': 'update_entity_user_data_filters', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_user_data_filter_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_user_data_filter_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERS": "users", - "USERGROUPS": "userGroups", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "USER": "user", - "USERGROUP": "userGroup", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_user_data_filter_in_document': - (JsonApiUserDataFilterInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_user_data_filter_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_visualization_objects_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiVisualizationObjectOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', - 'operation_id': 'update_entity_visualization_objects', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_visualization_object_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_visualization_object_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "CERTIFIEDBY": "certifiedBy", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_visualization_object_in_document': - (JsonApiVisualizationObjectInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_visualization_object_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_workspace_data_filter_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', - 'operation_id': 'update_entity_workspace_data_filter_settings', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_data_filter_setting_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_data_filter_setting_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "WORKSPACEDATAFILTERS": "workspaceDataFilters", - "WORKSPACEDATAFILTER": "workspaceDataFilter", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_workspace_data_filter_setting_in_document': - (JsonApiWorkspaceDataFilterSettingInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_workspace_data_filter_setting_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_workspace_data_filters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceDataFilterOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', - 'operation_id': 'update_entity_workspace_data_filters', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_data_filter_in_document', - 'filter', - 'include', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_data_filter_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { - - "WORKSPACEDATAFILTERSETTINGS": "workspaceDataFilterSettings", - "FILTERSETTINGS": "filterSettings", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_workspace_data_filter_in_document': - (JsonApiWorkspaceDataFilterInDocument,), - 'filter': - (str,), - 'include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - 'include': 'include', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_workspace_data_filter_in_document': 'body', - 'filter': 'query', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_workspace_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiWorkspaceSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', - 'operation_id': 'update_entity_workspace_settings', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_setting_in_document', - 'filter', - ], - 'required': [ - 'workspace_id', - 'object_id', - 'json_api_workspace_setting_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), - 'json_api_workspace_setting_in_document': - (JsonApiWorkspaceSettingInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', - 'filter': 'filter', - }, - 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_workspace_setting_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - - def create_entity_analytical_dashboards( - self, - workspace_id, - json_api_analytical_dashboard_post_optional_id_document, - **kwargs - ): - """Post Dashboards # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_analytical_dashboards(workspace_id, json_api_analytical_dashboard_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_analytical_dashboard_post_optional_id_document (JsonApiAnalyticalDashboardPostOptionalIdDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAnalyticalDashboardOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_analytical_dashboard_post_optional_id_document'] = \ - json_api_analytical_dashboard_post_optional_id_document - return self.create_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) - - def create_entity_attribute_hierarchies( - self, - workspace_id, - json_api_attribute_hierarchy_in_document, - **kwargs - ): - """Post Attribute Hierarchies # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_attribute_hierarchies(workspace_id, json_api_attribute_hierarchy_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_attribute_hierarchy_in_document (JsonApiAttributeHierarchyInDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAttributeHierarchyOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_attribute_hierarchy_in_document'] = \ - json_api_attribute_hierarchy_in_document - return self.create_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) - - def create_entity_automations( - self, - workspace_id, - json_api_automation_in_document, - **kwargs - ): - """Post Automations # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_automations(workspace_id, json_api_automation_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_automation_in_document (JsonApiAutomationInDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAutomationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_automation_in_document'] = \ - json_api_automation_in_document - return self.create_entity_automations_endpoint.call_with_http_info(**kwargs) - - def create_entity_custom_application_settings( - self, - workspace_id, - json_api_custom_application_setting_post_optional_id_document, - **kwargs - ): - """Post Custom Application Settings # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_custom_application_settings(workspace_id, json_api_custom_application_setting_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_custom_application_setting_post_optional_id_document (JsonApiCustomApplicationSettingPostOptionalIdDocument): - - Keyword Args: - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCustomApplicationSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_custom_application_setting_post_optional_id_document'] = \ - json_api_custom_application_setting_post_optional_id_document - return self.create_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) - - def create_entity_dashboard_plugins( - self, - workspace_id, - json_api_dashboard_plugin_post_optional_id_document, - **kwargs - ): - """Post Plugins # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_dashboard_plugins(workspace_id, json_api_dashboard_plugin_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_dashboard_plugin_post_optional_id_document (JsonApiDashboardPluginPostOptionalIdDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDashboardPluginOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_dashboard_plugin_post_optional_id_document'] = \ - json_api_dashboard_plugin_post_optional_id_document - return self.create_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) - - def create_entity_export_definitions( - self, - workspace_id, - json_api_export_definition_post_optional_id_document, - **kwargs - ): - """Post Export Definitions # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_export_definitions(workspace_id, json_api_export_definition_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_export_definition_post_optional_id_document (JsonApiExportDefinitionPostOptionalIdDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportDefinitionOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_export_definition_post_optional_id_document'] = \ - json_api_export_definition_post_optional_id_document - return self.create_entity_export_definitions_endpoint.call_with_http_info(**kwargs) - - def create_entity_filter_contexts( - self, - workspace_id, - json_api_filter_context_post_optional_id_document, - **kwargs - ): - """Post Filter Context # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_filter_contexts(workspace_id, json_api_filter_context_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_filter_context_post_optional_id_document (JsonApiFilterContextPostOptionalIdDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterContextOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_filter_context_post_optional_id_document'] = \ - json_api_filter_context_post_optional_id_document - return self.create_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) - - def create_entity_filter_views( - self, - workspace_id, - json_api_filter_view_in_document, - **kwargs - ): - """Post Filter views # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_filter_views(workspace_id, json_api_filter_view_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_filter_view_in_document (JsonApiFilterViewInDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterViewOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_filter_view_in_document'] = \ - json_api_filter_view_in_document - return self.create_entity_filter_views_endpoint.call_with_http_info(**kwargs) - - def create_entity_knowledge_recommendations( - self, - workspace_id, - json_api_knowledge_recommendation_post_optional_id_document, - **kwargs - ): - """create_entity_knowledge_recommendations # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_knowledge_recommendations(workspace_id, json_api_knowledge_recommendation_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_knowledge_recommendation_post_optional_id_document (JsonApiKnowledgeRecommendationPostOptionalIdDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiKnowledgeRecommendationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_knowledge_recommendation_post_optional_id_document'] = \ - json_api_knowledge_recommendation_post_optional_id_document - return self.create_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) - - def create_entity_memory_items( - self, - workspace_id, - json_api_memory_item_post_optional_id_document, - **kwargs - ): - """create_entity_memory_items # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_memory_items(workspace_id, json_api_memory_item_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_memory_item_post_optional_id_document (JsonApiMemoryItemPostOptionalIdDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiMemoryItemOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_memory_item_post_optional_id_document'] = \ - json_api_memory_item_post_optional_id_document - return self.create_entity_memory_items_endpoint.call_with_http_info(**kwargs) - - def create_entity_metrics( - self, - workspace_id, - json_api_metric_post_optional_id_document, - **kwargs - ): - """Post Metrics # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_metrics(workspace_id, json_api_metric_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_metric_post_optional_id_document (JsonApiMetricPostOptionalIdDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiMetricOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_metric_post_optional_id_document'] = \ - json_api_metric_post_optional_id_document - return self.create_entity_metrics_endpoint.call_with_http_info(**kwargs) - - def create_entity_user_data_filters( - self, - workspace_id, - json_api_user_data_filter_post_optional_id_document, - **kwargs - ): - """Post User Data Filters # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_user_data_filters(workspace_id, json_api_user_data_filter_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_user_data_filter_post_optional_id_document (JsonApiUserDataFilterPostOptionalIdDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserDataFilterOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_user_data_filter_post_optional_id_document'] = \ - json_api_user_data_filter_post_optional_id_document - return self.create_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) - - def create_entity_visualization_objects( - self, - workspace_id, - json_api_visualization_object_post_optional_id_document, - **kwargs - ): - """Post Visualization Objects # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_visualization_objects(workspace_id, json_api_visualization_object_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_visualization_object_post_optional_id_document (JsonApiVisualizationObjectPostOptionalIdDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiVisualizationObjectOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_visualization_object_post_optional_id_document'] = \ - json_api_visualization_object_post_optional_id_document - return self.create_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) - - def create_entity_workspace_data_filter_settings( - self, - workspace_id, - json_api_workspace_data_filter_setting_in_document, - **kwargs - ): - """Post Settings for Workspace Data Filters # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_workspace_data_filter_settings(workspace_id, json_api_workspace_data_filter_setting_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_workspace_data_filter_setting_in_document (JsonApiWorkspaceDataFilterSettingInDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_workspace_data_filter_setting_in_document'] = \ - json_api_workspace_data_filter_setting_in_document - return self.create_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) - - def create_entity_workspace_data_filters( - self, - workspace_id, - json_api_workspace_data_filter_in_document, - **kwargs - ): - """Post Workspace Data Filters # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_workspace_data_filters(workspace_id, json_api_workspace_data_filter_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_workspace_data_filter_in_document (JsonApiWorkspaceDataFilterInDocument): - - Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_workspace_data_filter_in_document'] = \ - json_api_workspace_data_filter_in_document - return self.create_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) - - def create_entity_workspace_settings( - self, - workspace_id, - json_api_workspace_setting_post_optional_id_document, - **kwargs - ): - """Post Settings for Workspaces # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - json_api_workspace_setting_post_optional_id_document (JsonApiWorkspaceSettingPostOptionalIdDocument): - - Keyword Args: - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_workspace_setting_post_optional_id_document'] = \ - json_api_workspace_setting_post_optional_id_document - return self.create_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) - - def delete_entity_analytical_dashboards( - self, - workspace_id, - object_id, - **kwargs - ): - """Delete a Dashboard # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_analytical_dashboards(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) - - def delete_entity_attribute_hierarchies( - self, - workspace_id, - object_id, - **kwargs - ): - """Delete an Attribute Hierarchy # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_attribute_hierarchies(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) - - def delete_entity_automations( - self, - workspace_id, - object_id, - **kwargs - ): - """Delete an Automation # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_automations(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_automations_endpoint.call_with_http_info(**kwargs) - - def delete_entity_custom_application_settings( - self, - workspace_id, - object_id, - **kwargs - ): - """Delete a Custom Application Setting # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_custom_application_settings(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) - - def delete_entity_dashboard_plugins( - self, - workspace_id, - object_id, - **kwargs - ): - """Delete a Plugin # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_dashboard_plugins(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) - - def delete_entity_export_definitions( - self, - workspace_id, - object_id, - **kwargs - ): - """Delete an Export Definition # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_export_definitions(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_export_definitions_endpoint.call_with_http_info(**kwargs) - - def delete_entity_filter_contexts( - self, - workspace_id, - object_id, - **kwargs - ): - """Delete a Filter Context # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_filter_contexts(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) - - def delete_entity_filter_views( - self, - workspace_id, - object_id, - **kwargs - ): - """Delete Filter view # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_filter_views(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_filter_views_endpoint.call_with_http_info(**kwargs) - - def delete_entity_knowledge_recommendations( - self, - workspace_id, - object_id, - **kwargs - ): - """delete_entity_knowledge_recommendations # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_knowledge_recommendations(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) - - def delete_entity_memory_items( - self, - workspace_id, - object_id, - **kwargs - ): - """delete_entity_memory_items # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_memory_items(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_memory_items_endpoint.call_with_http_info(**kwargs) - - def delete_entity_metrics( - self, - workspace_id, - object_id, - **kwargs - ): - """Delete a Metric # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_metrics(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_metrics_endpoint.call_with_http_info(**kwargs) - - def delete_entity_user_data_filters( - self, - workspace_id, - object_id, - **kwargs - ): - """Delete a User Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_user_data_filters(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) - - def delete_entity_visualization_objects( - self, - workspace_id, - object_id, - **kwargs - ): - """Delete a Visualization Object # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_visualization_objects(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) - - def delete_entity_workspace_data_filter_settings( - self, - workspace_id, - object_id, - **kwargs - ): - """Delete a Settings for Workspace Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_workspace_data_filter_settings(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) - - def delete_entity_workspace_data_filters( - self, - workspace_id, - object_id, - **kwargs - ): - """Delete a Workspace Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_workspace_data_filters(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) - - def delete_entity_workspace_settings( - self, - workspace_id, - object_id, - **kwargs - ): - """Delete a Setting for Workspace # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_workspace_settings(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_aggregated_facts( - self, - workspace_id, - **kwargs - ): - """get_all_entities_aggregated_facts # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_aggregated_facts(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAggregatedFactOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_aggregated_facts_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_analytical_dashboards( - self, - workspace_id, - **kwargs - ): - """Get all Dashboards # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_analytical_dashboards(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAnalyticalDashboardOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_analytical_dashboards_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_attribute_hierarchies( - self, - workspace_id, - **kwargs - ): - """Get all Attribute Hierarchies # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_attribute_hierarchies(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAttributeHierarchyOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_attributes( - self, - workspace_id, - **kwargs - ): - """Get all Attributes # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_attributes(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAttributeOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_attributes_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_automations( - self, - workspace_id, - **kwargs - ): - """Get all Automations # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_automations(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAutomationOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_automations_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_custom_application_settings( - self, - workspace_id, - **kwargs - ): - """Get all Custom Application Settings # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_custom_application_settings(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCustomApplicationSettingOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_custom_application_settings_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_dashboard_plugins( - self, - workspace_id, - **kwargs - ): - """Get all Plugins # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_dashboard_plugins(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDashboardPluginOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_dashboard_plugins_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_datasets( - self, - workspace_id, - **kwargs - ): - """Get all Datasets # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_datasets(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDatasetOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_datasets_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_export_definitions( - self, - workspace_id, - **kwargs - ): - """Get all Export Definitions # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_export_definitions(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportDefinitionOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_export_definitions_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_facts( - self, - workspace_id, - **kwargs - ): - """Get all Facts # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_facts(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFactOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_facts_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_filter_contexts( - self, - workspace_id, - **kwargs - ): - """Get all Filter Context # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_filter_contexts(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterContextOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_filter_contexts_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_filter_views( - self, - workspace_id, - **kwargs - ): - """Get all Filter views # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_filter_views(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterViewOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_filter_views_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_knowledge_recommendations( - self, - workspace_id, - **kwargs - ): - """get_all_entities_knowledge_recommendations # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_knowledge_recommendations(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiKnowledgeRecommendationOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_labels( - self, - workspace_id, - **kwargs - ): - """Get all Labels # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_labels(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiLabelOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_labels_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_memory_items( - self, - workspace_id, - **kwargs - ): - """get_all_entities_memory_items # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_memory_items(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiMemoryItemOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_memory_items_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_metrics( - self, - workspace_id, - **kwargs - ): - """Get all Metrics # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_metrics(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiMetricOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_metrics_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_user_data_filters( - self, - workspace_id, - **kwargs - ): - """Get all User Data Filters # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_user_data_filters(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserDataFilterOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_user_data_filters_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_visualization_objects( - self, - workspace_id, - **kwargs - ): - """Get all Visualization Objects # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_visualization_objects(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiVisualizationObjectOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_visualization_objects_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_workspace_data_filter_settings( - self, - workspace_id, - **kwargs - ): - """Get all Settings for Workspace Data Filters # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_workspace_data_filter_settings(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterSettingOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_workspace_data_filters( - self, - workspace_id, - **kwargs - ): - """Get all Workspace Data Filters # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_workspace_data_filters(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_workspace_data_filters_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_workspace_settings( - self, - workspace_id, - **kwargs - ): - """Get all Setting for Workspaces # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_workspace_settings(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceSettingOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_workspace_settings_endpoint.call_with_http_info(**kwargs) - - def get_entity_aggregated_facts( - self, - workspace_id, - object_id, - **kwargs - ): - """get_entity_aggregated_facts # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_aggregated_facts(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAggregatedFactOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_aggregated_facts_endpoint.call_with_http_info(**kwargs) - - def get_entity_analytical_dashboards( - self, - workspace_id, - object_id, - **kwargs - ): - """Get a Dashboard # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_analytical_dashboards(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAnalyticalDashboardOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) - - def get_entity_attribute_hierarchies( - self, - workspace_id, - object_id, - **kwargs - ): - """Get an Attribute Hierarchy # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_attribute_hierarchies(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAttributeHierarchyOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) - - def get_entity_attributes( - self, - workspace_id, - object_id, - **kwargs - ): - """Get an Attribute # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_attributes(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAttributeOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_attributes_endpoint.call_with_http_info(**kwargs) - - def get_entity_automations( - self, - workspace_id, - object_id, - **kwargs - ): - """Get an Automation # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_automations(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAutomationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_automations_endpoint.call_with_http_info(**kwargs) - - def get_entity_custom_application_settings( - self, - workspace_id, - object_id, - **kwargs - ): - """Get a Custom Application Setting # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_custom_application_settings(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCustomApplicationSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) - - def get_entity_dashboard_plugins( - self, - workspace_id, - object_id, - **kwargs - ): - """Get a Plugin # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_dashboard_plugins(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDashboardPluginOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) - - def get_entity_datasets( - self, - workspace_id, - object_id, - **kwargs - ): - """Get a Dataset # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_datasets(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDatasetOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_datasets_endpoint.call_with_http_info(**kwargs) - - def get_entity_export_definitions( - self, - workspace_id, - object_id, - **kwargs - ): - """Get an Export Definition # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_export_definitions(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportDefinitionOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_export_definitions_endpoint.call_with_http_info(**kwargs) - - def get_entity_facts( - self, - workspace_id, - object_id, - **kwargs - ): - """Get a Fact # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_facts(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFactOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_facts_endpoint.call_with_http_info(**kwargs) - - def get_entity_filter_contexts( - self, - workspace_id, - object_id, - **kwargs - ): - """Get a Filter Context # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_filter_contexts(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterContextOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) - - def get_entity_filter_views( - self, - workspace_id, - object_id, - **kwargs - ): - """Get Filter view # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_filter_views(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterViewOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_filter_views_endpoint.call_with_http_info(**kwargs) - - def get_entity_knowledge_recommendations( - self, - workspace_id, - object_id, - **kwargs - ): - """get_entity_knowledge_recommendations # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_knowledge_recommendations(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiKnowledgeRecommendationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) - - def get_entity_labels( - self, - workspace_id, - object_id, - **kwargs - ): - """Get a Label # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_labels(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiLabelOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_labels_endpoint.call_with_http_info(**kwargs) - - def get_entity_memory_items( - self, - workspace_id, - object_id, - **kwargs - ): - """get_entity_memory_items # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_memory_items(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiMemoryItemOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_memory_items_endpoint.call_with_http_info(**kwargs) - - def get_entity_metrics( - self, - workspace_id, - object_id, - **kwargs - ): - """Get a Metric # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_metrics(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiMetricOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_metrics_endpoint.call_with_http_info(**kwargs) - - def get_entity_user_data_filters( - self, - workspace_id, - object_id, - **kwargs - ): - """Get a User Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_user_data_filters(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserDataFilterOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) - - def get_entity_visualization_objects( - self, - workspace_id, - object_id, - **kwargs - ): - """Get a Visualization Object # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_visualization_objects(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiVisualizationObjectOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) - - def get_entity_workspace_data_filter_settings( - self, - workspace_id, - object_id, - **kwargs - ): - """Get a Setting for Workspace Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_workspace_data_filter_settings(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) - - def get_entity_workspace_data_filters( - self, - workspace_id, - object_id, - **kwargs - ): - """Get a Workspace Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_workspace_data_filters(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) - - def get_entity_workspace_settings( - self, - workspace_id, - object_id, - **kwargs - ): - """Get a Setting for Workspace # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_workspace_settings(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) - - def patch_entity_analytical_dashboards( - self, - workspace_id, - object_id, - json_api_analytical_dashboard_patch_document, - **kwargs - ): - """Patch a Dashboard # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_analytical_dashboard_patch_document (JsonApiAnalyticalDashboardPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAnalyticalDashboardOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_analytical_dashboard_patch_document'] = \ - json_api_analytical_dashboard_patch_document - return self.patch_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) - - def patch_entity_attribute_hierarchies( - self, - workspace_id, - object_id, - json_api_attribute_hierarchy_patch_document, - **kwargs - ): - """Patch an Attribute Hierarchy # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_attribute_hierarchy_patch_document (JsonApiAttributeHierarchyPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAttributeHierarchyOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_attribute_hierarchy_patch_document'] = \ - json_api_attribute_hierarchy_patch_document - return self.patch_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) - - def patch_entity_attributes( - self, - workspace_id, - object_id, - json_api_attribute_patch_document, - **kwargs - ): - """Patch an Attribute (beta) # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_attributes(workspace_id, object_id, json_api_attribute_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_attribute_patch_document (JsonApiAttributePatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAttributeOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_attribute_patch_document'] = \ - json_api_attribute_patch_document - return self.patch_entity_attributes_endpoint.call_with_http_info(**kwargs) - - def patch_entity_automations( - self, - workspace_id, - object_id, - json_api_automation_patch_document, - **kwargs - ): - """Patch an Automation # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_automation_patch_document (JsonApiAutomationPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAutomationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_automation_patch_document'] = \ - json_api_automation_patch_document - return self.patch_entity_automations_endpoint.call_with_http_info(**kwargs) - - def patch_entity_custom_application_settings( - self, - workspace_id, - object_id, - json_api_custom_application_setting_patch_document, - **kwargs - ): - """Patch a Custom Application Setting # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_custom_application_setting_patch_document (JsonApiCustomApplicationSettingPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCustomApplicationSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_custom_application_setting_patch_document'] = \ - json_api_custom_application_setting_patch_document - return self.patch_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) - - def patch_entity_dashboard_plugins( - self, - workspace_id, - object_id, - json_api_dashboard_plugin_patch_document, - **kwargs - ): - """Patch a Plugin # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_dashboard_plugin_patch_document (JsonApiDashboardPluginPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDashboardPluginOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_dashboard_plugin_patch_document'] = \ - json_api_dashboard_plugin_patch_document - return self.patch_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) - - def patch_entity_datasets( - self, - workspace_id, - object_id, - json_api_dataset_patch_document, - **kwargs - ): - """Patch a Dataset (beta) # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_datasets(workspace_id, object_id, json_api_dataset_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_dataset_patch_document (JsonApiDatasetPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDatasetOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_dataset_patch_document'] = \ - json_api_dataset_patch_document - return self.patch_entity_datasets_endpoint.call_with_http_info(**kwargs) - - def patch_entity_export_definitions( - self, - workspace_id, - object_id, - json_api_export_definition_patch_document, - **kwargs - ): - """Patch an Export Definition # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_export_definitions(workspace_id, object_id, json_api_export_definition_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_export_definition_patch_document (JsonApiExportDefinitionPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportDefinitionOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_export_definition_patch_document'] = \ - json_api_export_definition_patch_document - return self.patch_entity_export_definitions_endpoint.call_with_http_info(**kwargs) - - def patch_entity_facts( - self, - workspace_id, - object_id, - json_api_fact_patch_document, - **kwargs - ): - """Patch a Fact (beta) # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_facts(workspace_id, object_id, json_api_fact_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_fact_patch_document (JsonApiFactPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFactOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_fact_patch_document'] = \ - json_api_fact_patch_document - return self.patch_entity_facts_endpoint.call_with_http_info(**kwargs) - - def patch_entity_filter_contexts( - self, - workspace_id, - object_id, - json_api_filter_context_patch_document, - **kwargs - ): - """Patch a Filter Context # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_filter_context_patch_document (JsonApiFilterContextPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterContextOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_filter_context_patch_document'] = \ - json_api_filter_context_patch_document - return self.patch_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) - - def patch_entity_filter_views( - self, - workspace_id, - object_id, - json_api_filter_view_patch_document, - **kwargs - ): - """Patch Filter view # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_filter_views(workspace_id, object_id, json_api_filter_view_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_filter_view_patch_document (JsonApiFilterViewPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterViewOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_filter_view_patch_document'] = \ - json_api_filter_view_patch_document - return self.patch_entity_filter_views_endpoint.call_with_http_info(**kwargs) - - def patch_entity_knowledge_recommendations( - self, - workspace_id, - object_id, - json_api_knowledge_recommendation_patch_document, - **kwargs - ): - """patch_entity_knowledge_recommendations # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_knowledge_recommendation_patch_document (JsonApiKnowledgeRecommendationPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiKnowledgeRecommendationOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_knowledge_recommendation_patch_document'] = \ - json_api_knowledge_recommendation_patch_document - return self.patch_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) - - def patch_entity_labels( - self, - workspace_id, - object_id, - json_api_label_patch_document, - **kwargs - ): - """Patch a Label (beta) # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_labels(workspace_id, object_id, json_api_label_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_label_patch_document (JsonApiLabelPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiLabelOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_label_patch_document'] = \ - json_api_label_patch_document - return self.patch_entity_labels_endpoint.call_with_http_info(**kwargs) - - def patch_entity_memory_items( - self, - workspace_id, - object_id, - json_api_memory_item_patch_document, - **kwargs - ): - """patch_entity_memory_items # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_memory_items(workspace_id, object_id, json_api_memory_item_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_memory_item_patch_document (JsonApiMemoryItemPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiMemoryItemOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_memory_item_patch_document'] = \ - json_api_memory_item_patch_document - return self.patch_entity_memory_items_endpoint.call_with_http_info(**kwargs) - - def patch_entity_metrics( - self, - workspace_id, - object_id, - json_api_metric_patch_document, - **kwargs - ): - """Patch a Metric # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_metrics(workspace_id, object_id, json_api_metric_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_metric_patch_document (JsonApiMetricPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiMetricOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_metric_patch_document'] = \ - json_api_metric_patch_document - return self.patch_entity_metrics_endpoint.call_with_http_info(**kwargs) - - def patch_entity_user_data_filters( - self, - workspace_id, - object_id, - json_api_user_data_filter_patch_document, - **kwargs - ): - """Patch a User Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_user_data_filter_patch_document (JsonApiUserDataFilterPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserDataFilterOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_user_data_filter_patch_document'] = \ - json_api_user_data_filter_patch_document - return self.patch_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) - - def patch_entity_visualization_objects( - self, - workspace_id, - object_id, - json_api_visualization_object_patch_document, - **kwargs - ): - """Patch a Visualization Object # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_visualization_object_patch_document (JsonApiVisualizationObjectPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiVisualizationObjectOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_visualization_object_patch_document'] = \ - json_api_visualization_object_patch_document - return self.patch_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) - - def patch_entity_workspace_data_filter_settings( - self, - workspace_id, - object_id, - json_api_workspace_data_filter_setting_patch_document, - **kwargs - ): - """Patch a Settings for Workspace Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_workspace_data_filter_setting_patch_document (JsonApiWorkspaceDataFilterSettingPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_workspace_data_filter_setting_patch_document'] = \ - json_api_workspace_data_filter_setting_patch_document - return self.patch_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) - - def patch_entity_workspace_data_filters( - self, - workspace_id, - object_id, - json_api_workspace_data_filter_patch_document, - **kwargs - ): - """Patch a Workspace Data Filter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_workspace_data_filter_patch_document (JsonApiWorkspaceDataFilterPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_workspace_data_filter_patch_document'] = \ - json_api_workspace_data_filter_patch_document - return self.patch_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) - - def patch_entity_workspace_settings( - self, - workspace_id, - object_id, - json_api_workspace_setting_patch_document, - **kwargs - ): - """Patch a Setting for Workspace # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_patch_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_workspace_setting_patch_document (JsonApiWorkspaceSettingPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceSettingOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_workspace_setting_patch_document'] = \ - json_api_workspace_setting_patch_document - return self.patch_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) - - def search_entities_aggregated_facts( - self, - workspace_id, - entity_search_body, - **kwargs - ): - """Search request for AggregatedFact # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.search_entities_aggregated_facts(workspace_id, entity_search_body, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAggregatedFactOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['entity_search_body'] = \ - entity_search_body - return self.search_entities_aggregated_facts_endpoint.call_with_http_info(**kwargs) - - def search_entities_analytical_dashboards( - self, - workspace_id, - entity_search_body, - **kwargs - ): - """Search request for AnalyticalDashboard # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.search_entities_analytical_dashboards(workspace_id, entity_search_body, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAnalyticalDashboardOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['entity_search_body'] = \ - entity_search_body - return self.search_entities_analytical_dashboards_endpoint.call_with_http_info(**kwargs) - - def search_entities_attribute_hierarchies( - self, - workspace_id, - entity_search_body, - **kwargs - ): - """Search request for AttributeHierarchy # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.search_entities_attribute_hierarchies(workspace_id, entity_search_body, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAttributeHierarchyOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['entity_search_body'] = \ - entity_search_body - return self.search_entities_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) - - def search_entities_attributes( - self, - workspace_id, - entity_search_body, - **kwargs - ): - """Search request for Attribute # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.search_entities_attributes(workspace_id, entity_search_body, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAttributeOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['entity_search_body'] = \ - entity_search_body - return self.search_entities_attributes_endpoint.call_with_http_info(**kwargs) - - def search_entities_automation_results( - self, - workspace_id, - entity_search_body, - **kwargs - ): - """Search request for AutomationResult # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.search_entities_automation_results(workspace_id, entity_search_body, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAutomationResultOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['entity_search_body'] = \ - entity_search_body - return self.search_entities_automation_results_endpoint.call_with_http_info(**kwargs) - - def search_entities_automations( - self, - workspace_id, - entity_search_body, - **kwargs - ): - """Search request for Automation # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.search_entities_automations(workspace_id, entity_search_body, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiAutomationOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['entity_search_body'] = \ - entity_search_body - return self.search_entities_automations_endpoint.call_with_http_info(**kwargs) - - def search_entities_custom_application_settings( - self, - workspace_id, - entity_search_body, - **kwargs - ): - """Search request for CustomApplicationSetting # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.search_entities_custom_application_settings(workspace_id, entity_search_body, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiCustomApplicationSettingOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['entity_search_body'] = \ - entity_search_body - return self.search_entities_custom_application_settings_endpoint.call_with_http_info(**kwargs) - - def search_entities_dashboard_plugins( - self, - workspace_id, - entity_search_body, - **kwargs - ): - """Search request for DashboardPlugin # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.search_entities_dashboard_plugins(workspace_id, entity_search_body, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDashboardPluginOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['entity_search_body'] = \ - entity_search_body - return self.search_entities_dashboard_plugins_endpoint.call_with_http_info(**kwargs) - - def search_entities_datasets( - self, - workspace_id, - entity_search_body, - **kwargs - ): - """Search request for Dataset # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.search_entities_datasets(workspace_id, entity_search_body, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiDatasetOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['entity_search_body'] = \ - entity_search_body - return self.search_entities_datasets_endpoint.call_with_http_info(**kwargs) - - def search_entities_export_definitions( - self, - workspace_id, - entity_search_body, - **kwargs - ): - """Search request for ExportDefinition # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.search_entities_export_definitions(workspace_id, entity_search_body, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportDefinitionOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['entity_search_body'] = \ - entity_search_body - return self.search_entities_export_definitions_endpoint.call_with_http_info(**kwargs) - - def search_entities_facts( - self, - workspace_id, - entity_search_body, - **kwargs - ): - """Search request for Fact # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.search_entities_facts(workspace_id, entity_search_body, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFactOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['entity_search_body'] = \ - entity_search_body - return self.search_entities_facts_endpoint.call_with_http_info(**kwargs) - - def search_entities_filter_contexts( - self, - workspace_id, - entity_search_body, - **kwargs - ): - """Search request for FilterContext # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.search_entities_filter_contexts(workspace_id, entity_search_body, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterContextOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['entity_search_body'] = \ - entity_search_body - return self.search_entities_filter_contexts_endpoint.call_with_http_info(**kwargs) - - def search_entities_filter_views( - self, - workspace_id, - entity_search_body, - **kwargs - ): - """Search request for FilterView # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.search_entities_filter_views(workspace_id, entity_search_body, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiFilterViewOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['entity_search_body'] = \ - entity_search_body - return self.search_entities_filter_views_endpoint.call_with_http_info(**kwargs) - - def search_entities_knowledge_recommendations( - self, - workspace_id, - entity_search_body, - **kwargs - ): - """search_entities_knowledge_recommendations # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.search_entities_knowledge_recommendations(workspace_id, entity_search_body, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiKnowledgeRecommendationOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['entity_search_body'] = \ - entity_search_body - return self.search_entities_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) - - def search_entities_labels( - self, - workspace_id, - entity_search_body, - **kwargs - ): - """Search request for Label # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.search_entities_labels(workspace_id, entity_search_body, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiLabelOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['entity_search_body'] = \ - entity_search_body - return self.search_entities_labels_endpoint.call_with_http_info(**kwargs) - - def search_entities_memory_items( - self, - workspace_id, - entity_search_body, - **kwargs - ): - """Search request for MemoryItem # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.search_entities_memory_items(workspace_id, entity_search_body, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiMemoryItemOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['entity_search_body'] = \ - entity_search_body - return self.search_entities_memory_items_endpoint.call_with_http_info(**kwargs) - - def search_entities_metrics( - self, - workspace_id, - entity_search_body, - **kwargs - ): - """Search request for Metric # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.search_entities_metrics(workspace_id, entity_search_body, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiMetricOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['entity_search_body'] = \ - entity_search_body - return self.search_entities_metrics_endpoint.call_with_http_info(**kwargs) - - def search_entities_user_data_filters( - self, - workspace_id, - entity_search_body, - **kwargs - ): - """Search request for UserDataFilter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.search_entities_user_data_filters(workspace_id, entity_search_body, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiUserDataFilterOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['entity_search_body'] = \ - entity_search_body - return self.search_entities_user_data_filters_endpoint.call_with_http_info(**kwargs) - - def search_entities_visualization_objects( - self, - workspace_id, - entity_search_body, - **kwargs - ): - """Search request for VisualizationObject # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.search_entities_visualization_objects(workspace_id, entity_search_body, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiVisualizationObjectOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['entity_search_body'] = \ - entity_search_body - return self.search_entities_visualization_objects_endpoint.call_with_http_info(**kwargs) - - def search_entities_workspace_data_filter_settings( - self, - workspace_id, - entity_search_body, - **kwargs - ): - """Search request for WorkspaceDataFilterSetting # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.search_entities_workspace_data_filter_settings(workspace_id, entity_search_body, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options - - Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiWorkspaceDataFilterSettingOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['entity_search_body'] = \ - entity_search_body - return self.search_entities_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) - def search_entities_workspace_data_filters( + def create_entity_knowledge_recommendations( self, workspace_id, - entity_search_body, + json_api_knowledge_recommendation_post_optional_id_document, **kwargs ): - """Search request for WorkspaceDataFilter # noqa: E501 + """create_entity_knowledge_recommendations # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_workspace_data_filters(workspace_id, entity_search_body, async_req=True) + >>> thread = api.create_entity_knowledge_recommendations(workspace_id, json_api_knowledge_recommendation_post_optional_id_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): - entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options + json_api_knowledge_recommendation_post_optional_id_document (JsonApiKnowledgeRecommendationPostOptionalIdDocument): Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -21922,7 +1683,7 @@ def search_entities_workspace_data_filters( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceDataFilterOutList + JsonApiKnowledgeRecommendationOutDocument If the method is called asynchronously, returns the request thread. """ @@ -21953,31 +1714,31 @@ def search_entities_workspace_data_filters( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['entity_search_body'] = \ - entity_search_body - return self.search_entities_workspace_data_filters_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_knowledge_recommendation_post_optional_id_document'] = \ + json_api_knowledge_recommendation_post_optional_id_document + return self.create_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) - def search_entities_workspace_settings( + def create_entity_memory_items( self, workspace_id, - entity_search_body, + json_api_memory_item_post_optional_id_document, **kwargs ): - """search_entities_workspace_settings # noqa: E501 + """create_entity_memory_items # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_workspace_settings(workspace_id, entity_search_body, async_req=True) + >>> thread = api.create_entity_memory_items(workspace_id, json_api_memory_item_post_optional_id_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): - entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options + json_api_memory_item_post_optional_id_document (JsonApiMemoryItemPostOptionalIdDocument): Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -22010,7 +1771,7 @@ def search_entities_workspace_settings( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceSettingOutList + JsonApiMemoryItemOutDocument If the method is called asynchronously, returns the request thread. """ @@ -22041,33 +1802,30 @@ def search_entities_workspace_settings( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['entity_search_body'] = \ - entity_search_body - return self.search_entities_workspace_settings_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_memory_item_post_optional_id_document'] = \ + json_api_memory_item_post_optional_id_document + return self.create_entity_memory_items_endpoint.call_with_http_info(**kwargs) - def update_entity_analytical_dashboards( + def delete_entity_knowledge_recommendations( self, workspace_id, object_id, - json_api_analytical_dashboard_in_document, **kwargs ): - """Put Dashboards # noqa: E501 + """delete_entity_knowledge_recommendations # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_in_document, async_req=True) + >>> thread = api.delete_entity_knowledge_recommendations(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_analytical_dashboard_in_document (JsonApiAnalyticalDashboardInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -22100,7 +1858,7 @@ def update_entity_analytical_dashboards( async_req (bool): execute request asynchronously Returns: - JsonApiAnalyticalDashboardOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -22133,33 +1891,28 @@ def update_entity_analytical_dashboards( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_analytical_dashboard_in_document'] = \ - json_api_analytical_dashboard_in_document - return self.update_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) - def update_entity_attribute_hierarchies( + def delete_entity_memory_items( self, workspace_id, object_id, - json_api_attribute_hierarchy_in_document, **kwargs ): - """Put an Attribute Hierarchy # noqa: E501 + """delete_entity_memory_items # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_in_document, async_req=True) + >>> thread = api.delete_entity_memory_items(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_attribute_hierarchy_in_document (JsonApiAttributeHierarchyInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -22192,7 +1945,7 @@ def update_entity_attribute_hierarchies( async_req (bool): execute request asynchronously Returns: - JsonApiAttributeHierarchyOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -22225,33 +1978,33 @@ def update_entity_attribute_hierarchies( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_attribute_hierarchy_in_document'] = \ - json_api_attribute_hierarchy_in_document - return self.update_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_memory_items_endpoint.call_with_http_info(**kwargs) - def update_entity_automations( + def get_all_entities_aggregated_facts( self, workspace_id, - object_id, - json_api_automation_in_document, **kwargs ): - """Put an Automation # noqa: E501 + """get_all_entities_aggregated_facts # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_automations(workspace_id, object_id, json_api_automation_in_document, async_req=True) + >>> thread = api.get_all_entities_aggregated_facts(workspace_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): - object_id (str): - json_api_automation_in_document (JsonApiAutomationInDocument): Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -22284,7 +2037,7 @@ def update_entity_automations( async_req (bool): execute request asynchronously Returns: - JsonApiAutomationOutDocument + JsonApiAggregatedFactOutList If the method is called asynchronously, returns the request thread. """ @@ -22315,34 +2068,33 @@ def update_entity_automations( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_automation_in_document'] = \ - json_api_automation_in_document - return self.update_entity_automations_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_aggregated_facts_endpoint.call_with_http_info(**kwargs) - def update_entity_custom_application_settings( + def get_all_entities_knowledge_recommendations( self, workspace_id, - object_id, - json_api_custom_application_setting_in_document, **kwargs ): - """Put a Custom Application Setting # noqa: E501 + """get_all_entities_knowledge_recommendations # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_in_document, async_req=True) + >>> thread = api.get_all_entities_knowledge_recommendations(workspace_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): - object_id (str): - json_api_custom_application_setting_in_document (JsonApiCustomApplicationSettingInDocument): Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -22375,7 +2127,7 @@ def update_entity_custom_application_settings( async_req (bool): execute request asynchronously Returns: - JsonApiCustomApplicationSettingOutDocument + JsonApiKnowledgeRecommendationOutList If the method is called asynchronously, returns the request thread. """ @@ -22406,35 +2158,33 @@ def update_entity_custom_application_settings( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_custom_application_setting_in_document'] = \ - json_api_custom_application_setting_in_document - return self.update_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) - def update_entity_dashboard_plugins( + def get_all_entities_memory_items( self, workspace_id, - object_id, - json_api_dashboard_plugin_in_document, **kwargs ): - """Put a Plugin # noqa: E501 + """get_all_entities_memory_items # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_in_document, async_req=True) + >>> thread = api.get_all_entities_memory_items(workspace_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): - object_id (str): - json_api_dashboard_plugin_in_document (JsonApiDashboardPluginInDocument): Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -22467,7 +2217,7 @@ def update_entity_dashboard_plugins( async_req (bool): execute request asynchronously Returns: - JsonApiDashboardPluginOutDocument + JsonApiMemoryItemOutList If the method is called asynchronously, returns the request thread. """ @@ -22498,35 +2248,31 @@ def update_entity_dashboard_plugins( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_dashboard_plugin_in_document'] = \ - json_api_dashboard_plugin_in_document - return self.update_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_memory_items_endpoint.call_with_http_info(**kwargs) - def update_entity_export_definitions( + def get_entity_aggregated_facts( self, workspace_id, object_id, - json_api_export_definition_in_document, **kwargs ): - """Put an Export Definition # noqa: E501 + """get_entity_aggregated_facts # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_export_definitions(workspace_id, object_id, json_api_export_definition_in_document, async_req=True) + >>> thread = api.get_entity_aggregated_facts(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_export_definition_in_document (JsonApiExportDefinitionInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -22559,7 +2305,7 @@ def update_entity_export_definitions( async_req (bool): execute request asynchronously Returns: - JsonApiExportDefinitionOutDocument + JsonApiAggregatedFactOutDocument If the method is called asynchronously, returns the request thread. """ @@ -22592,33 +2338,31 @@ def update_entity_export_definitions( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_export_definition_in_document'] = \ - json_api_export_definition_in_document - return self.update_entity_export_definitions_endpoint.call_with_http_info(**kwargs) + return self.get_entity_aggregated_facts_endpoint.call_with_http_info(**kwargs) - def update_entity_filter_contexts( + def get_entity_knowledge_recommendations( self, workspace_id, object_id, - json_api_filter_context_in_document, **kwargs ): - """Put a Filter Context # noqa: E501 + """get_entity_knowledge_recommendations # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_in_document, async_req=True) + >>> thread = api.get_entity_knowledge_recommendations(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_filter_context_in_document (JsonApiFilterContextInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -22651,7 +2395,7 @@ def update_entity_filter_contexts( async_req (bool): execute request asynchronously Returns: - JsonApiFilterContextOutDocument + JsonApiKnowledgeRecommendationOutDocument If the method is called asynchronously, returns the request thread. """ @@ -22684,33 +2428,31 @@ def update_entity_filter_contexts( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_filter_context_in_document'] = \ - json_api_filter_context_in_document - return self.update_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) + return self.get_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) - def update_entity_filter_views( + def get_entity_memory_items( self, workspace_id, object_id, - json_api_filter_view_in_document, **kwargs ): - """Put Filter views # noqa: E501 + """get_entity_memory_items # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_filter_views(workspace_id, object_id, json_api_filter_view_in_document, async_req=True) + >>> thread = api.get_entity_memory_items(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_filter_view_in_document (JsonApiFilterViewInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -22743,7 +2485,7 @@ def update_entity_filter_views( async_req (bool): execute request asynchronously Returns: - JsonApiFilterViewOutDocument + JsonApiMemoryItemOutDocument If the method is called asynchronously, returns the request thread. """ @@ -22776,29 +2518,27 @@ def update_entity_filter_views( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_filter_view_in_document'] = \ - json_api_filter_view_in_document - return self.update_entity_filter_views_endpoint.call_with_http_info(**kwargs) + return self.get_entity_memory_items_endpoint.call_with_http_info(**kwargs) - def update_entity_knowledge_recommendations( + def patch_entity_knowledge_recommendations( self, workspace_id, object_id, - json_api_knowledge_recommendation_in_document, + json_api_knowledge_recommendation_patch_document, **kwargs ): - """update_entity_knowledge_recommendations # noqa: E501 + """patch_entity_knowledge_recommendations # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_in_document, async_req=True) + >>> thread = api.patch_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_patch_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_knowledge_recommendation_in_document (JsonApiKnowledgeRecommendationInDocument): + json_api_knowledge_recommendation_patch_document (JsonApiKnowledgeRecommendationPatchDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -22868,29 +2608,29 @@ def update_entity_knowledge_recommendations( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_knowledge_recommendation_in_document'] = \ - json_api_knowledge_recommendation_in_document - return self.update_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_knowledge_recommendation_patch_document'] = \ + json_api_knowledge_recommendation_patch_document + return self.patch_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) - def update_entity_memory_items( + def patch_entity_memory_items( self, workspace_id, object_id, - json_api_memory_item_in_document, + json_api_memory_item_patch_document, **kwargs ): - """update_entity_memory_items # noqa: E501 + """patch_entity_memory_items # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_memory_items(workspace_id, object_id, json_api_memory_item_in_document, async_req=True) + >>> thread = api.patch_entity_memory_items(workspace_id, object_id, json_api_memory_item_patch_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_memory_item_in_document (JsonApiMemoryItemInDocument): + json_api_memory_item_patch_document (JsonApiMemoryItemPatchDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -22960,33 +2700,31 @@ def update_entity_memory_items( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_memory_item_in_document'] = \ - json_api_memory_item_in_document - return self.update_entity_memory_items_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_memory_item_patch_document'] = \ + json_api_memory_item_patch_document + return self.patch_entity_memory_items_endpoint.call_with_http_info(**kwargs) - def update_entity_metrics( + def search_entities_aggregated_facts( self, workspace_id, - object_id, - json_api_metric_in_document, + entity_search_body, **kwargs ): - """Put a Metric # noqa: E501 + """Search request for AggregatedFact # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_metrics(workspace_id, object_id, json_api_metric_in_document, async_req=True) + >>> thread = api.search_entities_aggregated_facts(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: workspace_id (str): - object_id (str): - json_api_metric_in_document (JsonApiMetricInDocument): + entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + origin (str): [optional] if omitted the server will use the default value of "ALL" + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -23019,7 +2757,7 @@ def update_entity_metrics( async_req (bool): execute request asynchronously Returns: - JsonApiMetricOutDocument + JsonApiAggregatedFactOutList If the method is called asynchronously, returns the request thread. """ @@ -23050,35 +2788,31 @@ def update_entity_metrics( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_metric_in_document'] = \ - json_api_metric_in_document - return self.update_entity_metrics_endpoint.call_with_http_info(**kwargs) + kwargs['entity_search_body'] = \ + entity_search_body + return self.search_entities_aggregated_facts_endpoint.call_with_http_info(**kwargs) - def update_entity_user_data_filters( + def search_entities_automation_results( self, workspace_id, - object_id, - json_api_user_data_filter_in_document, + entity_search_body, **kwargs ): - """Put a User Data Filter # noqa: E501 + """Search request for AutomationResult # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_in_document, async_req=True) + >>> thread = api.search_entities_automation_results(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: workspace_id (str): - object_id (str): - json_api_user_data_filter_in_document (JsonApiUserDataFilterInDocument): + entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + origin (str): [optional] if omitted the server will use the default value of "ALL" + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -23111,7 +2845,7 @@ def update_entity_user_data_filters( async_req (bool): execute request asynchronously Returns: - JsonApiUserDataFilterOutDocument + JsonApiAutomationResultOutList If the method is called asynchronously, returns the request thread. """ @@ -23142,35 +2876,31 @@ def update_entity_user_data_filters( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_user_data_filter_in_document'] = \ - json_api_user_data_filter_in_document - return self.update_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) + kwargs['entity_search_body'] = \ + entity_search_body + return self.search_entities_automation_results_endpoint.call_with_http_info(**kwargs) - def update_entity_visualization_objects( + def search_entities_knowledge_recommendations( self, workspace_id, - object_id, - json_api_visualization_object_in_document, + entity_search_body, **kwargs ): - """Put a Visualization Object # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_in_document, async_req=True) + >>> thread = api.search_entities_knowledge_recommendations(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: workspace_id (str): - object_id (str): - json_api_visualization_object_in_document (JsonApiVisualizationObjectInDocument): + entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + origin (str): [optional] if omitted the server will use the default value of "ALL" + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -23203,7 +2933,7 @@ def update_entity_visualization_objects( async_req (bool): execute request asynchronously Returns: - JsonApiVisualizationObjectOutDocument + JsonApiKnowledgeRecommendationOutList If the method is called asynchronously, returns the request thread. """ @@ -23234,35 +2964,31 @@ def update_entity_visualization_objects( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_visualization_object_in_document'] = \ - json_api_visualization_object_in_document - return self.update_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) + kwargs['entity_search_body'] = \ + entity_search_body + return self.search_entities_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) - def update_entity_workspace_data_filter_settings( + def search_entities_memory_items( self, workspace_id, - object_id, - json_api_workspace_data_filter_setting_in_document, + entity_search_body, **kwargs ): - """Put a Settings for Workspace Data Filter # noqa: E501 + """Search request for MemoryItem # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_in_document, async_req=True) + >>> thread = api.search_entities_memory_items(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: workspace_id (str): - object_id (str): - json_api_workspace_data_filter_setting_in_document (JsonApiWorkspaceDataFilterSettingInDocument): + entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + origin (str): [optional] if omitted the server will use the default value of "ALL" + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -23295,7 +3021,7 @@ def update_entity_workspace_data_filter_settings( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceDataFilterSettingOutDocument + JsonApiMemoryItemOutList If the method is called asynchronously, returns the request thread. """ @@ -23326,31 +3052,29 @@ def update_entity_workspace_data_filter_settings( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_workspace_data_filter_setting_in_document'] = \ - json_api_workspace_data_filter_setting_in_document - return self.update_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) + kwargs['entity_search_body'] = \ + entity_search_body + return self.search_entities_memory_items_endpoint.call_with_http_info(**kwargs) - def update_entity_workspace_data_filters( + def update_entity_knowledge_recommendations( self, workspace_id, object_id, - json_api_workspace_data_filter_in_document, + json_api_knowledge_recommendation_in_document, **kwargs ): - """Put a Workspace Data Filter # noqa: E501 + """update_entity_knowledge_recommendations # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_in_document, async_req=True) + >>> thread = api.update_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_in_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_workspace_data_filter_in_document (JsonApiWorkspaceDataFilterInDocument): + json_api_knowledge_recommendation_in_document (JsonApiKnowledgeRecommendationInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -23387,7 +3111,7 @@ def update_entity_workspace_data_filters( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceDataFilterOutDocument + JsonApiKnowledgeRecommendationOutDocument If the method is called asynchronously, returns the request thread. """ @@ -23420,32 +3144,33 @@ def update_entity_workspace_data_filters( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_workspace_data_filter_in_document'] = \ - json_api_workspace_data_filter_in_document - return self.update_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_knowledge_recommendation_in_document'] = \ + json_api_knowledge_recommendation_in_document + return self.update_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) - def update_entity_workspace_settings( + def update_entity_memory_items( self, workspace_id, object_id, - json_api_workspace_setting_in_document, + json_api_memory_item_in_document, **kwargs ): - """Put a Setting for a Workspace # noqa: E501 + """update_entity_memory_items # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_in_document, async_req=True) + >>> thread = api.update_entity_memory_items(workspace_id, object_id, json_api_memory_item_in_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_workspace_setting_in_document (JsonApiWorkspaceSettingInDocument): + json_api_memory_item_in_document (JsonApiMemoryItemInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -23478,7 +3203,7 @@ def update_entity_workspace_settings( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceSettingOutDocument + JsonApiMemoryItemOutDocument If the method is called asynchronously, returns the request thread. """ @@ -23511,7 +3236,7 @@ def update_entity_workspace_settings( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_workspace_setting_in_document'] = \ - json_api_workspace_setting_in_document - return self.update_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_memory_item_in_document'] = \ + json_api_memory_item_in_document + return self.update_entity_memory_items_endpoint.call_with_http_info(**kwargs) diff --git a/gooddata-api-client/gooddata_api_client/api/workspace_setting_controller_api.py b/gooddata-api-client/gooddata_api_client/api/workspace_setting_controller_api.py new file mode 100644 index 000000000..c67a099c1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/workspace_setting_controller_api.py @@ -0,0 +1,1200 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint +from gooddata_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from gooddata_api_client.model.entity_search_body import EntitySearchBody +from gooddata_api_client.model.json_api_workspace_setting_in_document import JsonApiWorkspaceSettingInDocument +from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.model.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList +from gooddata_api_client.model.json_api_workspace_setting_patch_document import JsonApiWorkspaceSettingPatchDocument +from gooddata_api_client.model.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument + + +class WorkspaceSettingControllerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_entity_workspace_settings_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceSettingOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings', + 'operation_id': 'create_entity_workspace_settings', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_workspace_setting_post_optional_id_document', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_workspace_setting_post_optional_id_document', + ], + 'nullable': [ + ], + 'enum': [ + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'json_api_workspace_setting_post_optional_id_document': + (JsonApiWorkspaceSettingPostOptionalIdDocument,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_workspace_setting_post_optional_id_document': 'body', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.delete_entity_workspace_settings_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', + 'operation_id': 'delete_entity_workspace_settings', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_entities_workspace_settings_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceSettingOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings', + 'operation_id': 'get_all_entities_workspace_settings', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'origin', + 'filter', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'origin': + (str,), + 'filter': + (str,), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'filter': 'filter', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'origin': 'query', + 'filter': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_workspace_settings_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceSettingOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', + 'operation_id': 'get_entity_workspace_settings', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.patch_entity_workspace_settings_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceSettingOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', + 'operation_id': 'patch_entity_workspace_settings', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_setting_patch_document', + 'filter', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_setting_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_workspace_setting_patch_document': + (JsonApiWorkspaceSettingPatchDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_workspace_setting_patch_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.search_entities_workspace_settings_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceSettingOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/search', + 'operation_id': 'search_entities_workspace_settings', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'entity_search_body', + 'origin', + 'x_gdc_validate_relations', + ], + 'required': [ + 'workspace_id', + 'entity_search_body', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'entity_search_body': + (EntitySearchBody,), + 'origin': + (str,), + 'x_gdc_validate_relations': + (bool,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + }, + 'location_map': { + 'workspace_id': 'path', + 'entity_search_body': 'body', + 'origin': 'query', + 'x_gdc_validate_relations': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_entity_workspace_settings_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceSettingOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', + 'operation_id': 'update_entity_workspace_settings', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_setting_in_document', + 'filter', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_setting_in_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_workspace_setting_in_document': + (JsonApiWorkspaceSettingInDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_workspace_setting_in_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + + def create_entity_workspace_settings( + self, + workspace_id, + json_api_workspace_setting_post_optional_id_document, + **kwargs + ): + """Post Settings for Workspaces # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_workspace_setting_post_optional_id_document (JsonApiWorkspaceSettingPostOptionalIdDocument): + + Keyword Args: + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiWorkspaceSettingOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['json_api_workspace_setting_post_optional_id_document'] = \ + json_api_workspace_setting_post_optional_id_document + return self.create_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) + + def delete_entity_workspace_settings( + self, + workspace_id, + object_id, + **kwargs + ): + """Delete a Setting for Workspace # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_entity_workspace_settings(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_workspace_settings( + self, + workspace_id, + **kwargs + ): + """Get all Setting for Workspaces # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_workspace_settings(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiWorkspaceSettingOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_workspace_settings_endpoint.call_with_http_info(**kwargs) + + def get_entity_workspace_settings( + self, + workspace_id, + object_id, + **kwargs + ): + """Get a Setting for Workspace # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_workspace_settings(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiWorkspaceSettingOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) + + def patch_entity_workspace_settings( + self, + workspace_id, + object_id, + json_api_workspace_setting_patch_document, + **kwargs + ): + """Patch a Setting for Workspace # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_workspace_setting_patch_document (JsonApiWorkspaceSettingPatchDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiWorkspaceSettingOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_workspace_setting_patch_document'] = \ + json_api_workspace_setting_patch_document + return self.patch_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) + + def search_entities_workspace_settings( + self, + workspace_id, + entity_search_body, + **kwargs + ): + """The search endpoint (beta) # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_entities_workspace_settings(workspace_id, entity_search_body, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiWorkspaceSettingOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['entity_search_body'] = \ + entity_search_body + return self.search_entities_workspace_settings_endpoint.call_with_http_info(**kwargs) + + def update_entity_workspace_settings( + self, + workspace_id, + object_id, + json_api_workspace_setting_in_document, + **kwargs + ): + """Put a Setting for a Workspace # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_workspace_setting_in_document (JsonApiWorkspaceSettingInDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiWorkspaceSettingOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_workspace_setting_in_document'] = \ + json_api_workspace_setting_in_document + return self.update_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/workspaces_settings_api.py b/gooddata-api-client/gooddata_api_client/api/workspaces_settings_api.py index b9e6b7c0d..379692311 100644 --- a/gooddata-api-client/gooddata_api_client/api/workspaces_settings_api.py +++ b/gooddata-api-client/gooddata_api_client/api/workspaces_settings_api.py @@ -2124,7 +2124,7 @@ def search_entities_custom_application_settings( entity_search_body, **kwargs ): - """Search request for CustomApplicationSetting # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2212,7 +2212,7 @@ def search_entities_workspace_settings( entity_search_body, **kwargs ): - """search_entities_workspace_settings # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/apis/__init__.py b/gooddata-api-client/gooddata_api_client/apis/__init__.py index ef0cc377b..61797be1f 100644 --- a/gooddata-api-client/gooddata_api_client/apis/__init__.py +++ b/gooddata-api-client/gooddata_api_client/apis/__init__.py @@ -87,10 +87,33 @@ from gooddata_api_client.api.workspaces_settings_api import WorkspacesSettingsApi from gooddata_api_client.api.aac_api import AacApi from gooddata_api_client.api.actions_api import ActionsApi +from gooddata_api_client.api.analytical_dashboard_controller_api import AnalyticalDashboardControllerApi +from gooddata_api_client.api.api_token_controller_api import ApiTokenControllerApi +from gooddata_api_client.api.attribute_controller_api import AttributeControllerApi +from gooddata_api_client.api.attribute_hierarchy_controller_api import AttributeHierarchyControllerApi +from gooddata_api_client.api.automation_controller_api import AutomationControllerApi from gooddata_api_client.api.automation_organization_view_controller_api import AutomationOrganizationViewControllerApi +from gooddata_api_client.api.cookie_security_configuration_controller_api import CookieSecurityConfigurationControllerApi +from gooddata_api_client.api.custom_application_setting_controller_api import CustomApplicationSettingControllerApi +from gooddata_api_client.api.custom_geo_collection_controller_api import CustomGeoCollectionControllerApi +from gooddata_api_client.api.dashboard_plugin_controller_api import DashboardPluginControllerApi +from gooddata_api_client.api.data_source_controller_api import DataSourceControllerApi +from gooddata_api_client.api.dataset_controller_api import DatasetControllerApi from gooddata_api_client.api.entities_api import EntitiesApi +from gooddata_api_client.api.export_definition_controller_api import ExportDefinitionControllerApi +from gooddata_api_client.api.fact_controller_api import FactControllerApi +from gooddata_api_client.api.filter_context_controller_api import FilterContextControllerApi +from gooddata_api_client.api.filter_view_controller_api import FilterViewControllerApi +from gooddata_api_client.api.jwk_controller_api import JwkControllerApi +from gooddata_api_client.api.label_controller_api import LabelControllerApi from gooddata_api_client.api.layout_api import LayoutApi -from gooddata_api_client.api.organization_controller_api import OrganizationControllerApi +from gooddata_api_client.api.metric_controller_api import MetricControllerApi +from gooddata_api_client.api.organization_entity_controller_api import OrganizationEntityControllerApi from gooddata_api_client.api.organization_model_controller_api import OrganizationModelControllerApi -from gooddata_api_client.api.user_model_controller_api import UserModelControllerApi +from gooddata_api_client.api.user_data_filter_controller_api import UserDataFilterControllerApi +from gooddata_api_client.api.user_setting_controller_api import UserSettingControllerApi +from gooddata_api_client.api.visualization_object_controller_api import VisualizationObjectControllerApi +from gooddata_api_client.api.workspace_data_filter_controller_api import WorkspaceDataFilterControllerApi +from gooddata_api_client.api.workspace_data_filter_setting_controller_api import WorkspaceDataFilterSettingControllerApi from gooddata_api_client.api.workspace_object_controller_api import WorkspaceObjectControllerApi +from gooddata_api_client.api.workspace_setting_controller_api import WorkspaceSettingControllerApi diff --git a/gooddata-api-client/gooddata_api_client/model/attribute_header_attribute_header.py b/gooddata-api-client/gooddata_api_client/model/attribute_header_attribute_header.py index b3bf9a18d..67e185fcf 100644 --- a/gooddata-api-client/gooddata_api_client/model/attribute_header_attribute_header.py +++ b/gooddata-api-client/gooddata_api_client/model/attribute_header_attribute_header.py @@ -92,6 +92,7 @@ class AttributeHeaderAttributeHeader(ModelNormal): 'GEO_LONGITUDE': "GEO_LONGITUDE", 'GEO_LATITUDE': "GEO_LATITUDE", 'GEO_AREA': "GEO_AREA", + 'GEO_ICON': "GEO_ICON", 'IMAGE': "IMAGE", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/azure_foundry_provider_config.py b/gooddata-api-client/gooddata_api_client/model/azure_foundry_provider_config.py index aef53e2ec..5b4598daf 100644 --- a/gooddata-api-client/gooddata_api_client/model/azure_foundry_provider_config.py +++ b/gooddata-api-client/gooddata_api_client/model/azure_foundry_provider_config.py @@ -122,7 +122,7 @@ def _from_openapi_data(cls, auth, endpoint, *args, **kwargs): # noqa: E501 Args: auth (AzureFoundryProviderAuth): - endpoint (str): Azure AI inference endpoint URL. + endpoint (str): Azure OpenAI endpoint URL. Keyword Args: type (str): Provider type.. defaults to "AZURE_FOUNDRY", must be one of ["AZURE_FOUNDRY", ] # noqa: E501 @@ -216,7 +216,7 @@ def __init__(self, auth, endpoint, *args, **kwargs): # noqa: E501 Args: auth (AzureFoundryProviderAuth): - endpoint (str): Azure AI inference endpoint URL. + endpoint (str): Azure OpenAI endpoint URL. Keyword Args: type (str): Provider type.. defaults to "AZURE_FOUNDRY", must be one of ["AZURE_FOUNDRY", ] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/column_override.py b/gooddata-api-client/gooddata_api_client/model/column_override.py index d81b231e2..d989eacbb 100644 --- a/gooddata-api-client/gooddata_api_client/model/column_override.py +++ b/gooddata-api-client/gooddata_api_client/model/column_override.py @@ -63,6 +63,7 @@ class ColumnOverride(ModelNormal): 'GEO_LONGITUDE': "GEO_LONGITUDE", 'GEO_LATITUDE': "GEO_LATITUDE", 'GEO_AREA': "GEO_AREA", + 'GEO_ICON': "GEO_ICON", 'IMAGE': "IMAGE", }, ('ldm_type_override',): { diff --git a/gooddata-api-client/gooddata_api_client/model/dashboard_context.py b/gooddata-api-client/gooddata_api_client/model/dashboard_context.py new file mode 100644 index 000000000..f60ea66b4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/dashboard_context.py @@ -0,0 +1,282 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.dashboard_context_widgets_inner import DashboardContextWidgetsInner + globals()['DashboardContextWidgetsInner'] = DashboardContextWidgetsInner + + +class DashboardContext(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'widgets': ([DashboardContextWidgetsInner],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'widgets': 'widgets', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, widgets, *args, **kwargs): # noqa: E501 + """DashboardContext - a model defined in OpenAPI + + Args: + id (str): Dashboard object ID. + widgets ([DashboardContextWidgetsInner]): Widgets currently visible on the dashboard. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + self.widgets = widgets + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, id, widgets, *args, **kwargs): # noqa: E501 + """DashboardContext - a model defined in OpenAPI + + Args: + id (str): Dashboard object ID. + widgets ([DashboardContextWidgetsInner]): Widgets currently visible on the dashboard. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + self.widgets = widgets + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/dashboard_context_widgets_inner.py b/gooddata-api-client/gooddata_api_client/model/dashboard_context_widgets_inner.py new file mode 100644 index 000000000..e1b801744 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/dashboard_context_widgets_inner.py @@ -0,0 +1,360 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.insight_widget_descriptor import InsightWidgetDescriptor + from gooddata_api_client.model.rich_text_widget_descriptor import RichTextWidgetDescriptor + from gooddata_api_client.model.visualization_switcher_widget_descriptor import VisualizationSwitcherWidgetDescriptor + globals()['InsightWidgetDescriptor'] = InsightWidgetDescriptor + globals()['RichTextWidgetDescriptor'] = RichTextWidgetDescriptor + globals()['VisualizationSwitcherWidgetDescriptor'] = VisualizationSwitcherWidgetDescriptor + + +class DashboardContextWidgetsInner(ModelComposed): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'widget_type': (str,), # noqa: E501 + 'result_id': (str,), # noqa: E501 + 'title': (str,), # noqa: E501 + 'widget_id': (str,), # noqa: E501 + 'active_visualization_id': (str,), # noqa: E501 + 'visualization_ids': ([str],), # noqa: E501 + 'visualization_id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + lazy_import() + val = { + 'InsightWidgetDescriptor': InsightWidgetDescriptor, + 'RichTextWidgetDescriptor': RichTextWidgetDescriptor, + 'VisualizationSwitcherWidgetDescriptor': VisualizationSwitcherWidgetDescriptor, + 'insight': InsightWidgetDescriptor, + 'richText': RichTextWidgetDescriptor, + 'visualizationSwitcher': VisualizationSwitcherWidgetDescriptor, + } + if not val: + return None + return {'widget_type': val} + + attribute_map = { + 'widget_type': 'widgetType', # noqa: E501 + 'result_id': 'resultId', # noqa: E501 + 'title': 'title', # noqa: E501 + 'widget_id': 'widgetId', # noqa: E501 + 'active_visualization_id': 'activeVisualizationId', # noqa: E501 + 'visualization_ids': 'visualizationIds', # noqa: E501 + 'visualization_id': 'visualizationId', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """DashboardContextWidgetsInner - a model defined in OpenAPI + + Keyword Args: + widget_type (str): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + result_id (str): Signed result ID for the currently active visualization's execution result.. [optional] # noqa: E501 + title (str): Widget title as displayed on the dashboard.. [optional] # noqa: E501 + widget_id (str): Widget object ID.. [optional] # noqa: E501 + active_visualization_id (str): ID of the currently active visualization in the switcher.. [optional] # noqa: E501 + visualization_ids ([str]): IDs of all visualizations available in the switcher.. [optional] # noqa: E501 + visualization_id (str): Visualization object ID referenced by this insight widget.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """DashboardContextWidgetsInner - a model defined in OpenAPI + + Keyword Args: + widget_type (str): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + result_id (str): Signed result ID for the currently active visualization's execution result.. [optional] # noqa: E501 + title (str): Widget title as displayed on the dashboard.. [optional] # noqa: E501 + widget_id (str): Widget object ID.. [optional] # noqa: E501 + active_visualization_id (str): ID of the currently active visualization in the switcher.. [optional] # noqa: E501 + visualization_ids ([str]): IDs of all visualizations available in the switcher.. [optional] # noqa: E501 + visualization_id (str): Visualization object ID referenced by this insight widget.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + ], + 'oneOf': [ + InsightWidgetDescriptor, + RichTextWidgetDescriptor, + VisualizationSwitcherWidgetDescriptor, + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/dashboard_date_filter_date_filter.py b/gooddata-api-client/gooddata_api_client/model/dashboard_date_filter_date_filter.py index 9c8cd7287..5761da616 100644 --- a/gooddata-api-client/gooddata_api_client/model/dashboard_date_filter_date_filter.py +++ b/gooddata-api-client/gooddata_api_client/model/dashboard_date_filter_date_filter.py @@ -97,9 +97,9 @@ class DashboardDateFilterDateFilter(ModelNormal): 'ABSOLUTE': "absolute", }, ('empty_value_handling',): { - 'INCLUDE': "INCLUDE", - 'EXCLUDE': "EXCLUDE", - 'ONLY': "ONLY", + 'INCLUDE': "include", + 'EXCLUDE': "exclude", + 'ONLY': "only", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_label.py b/gooddata-api-client/gooddata_api_client/model/declarative_label.py index 38ea58020..f53b792c6 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_label.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_label.py @@ -78,6 +78,7 @@ class DeclarativeLabel(ModelNormal): 'GEO_LONGITUDE': "GEO_LONGITUDE", 'GEO_LATITUDE': "GEO_LATITUDE", 'GEO_AREA': "GEO_AREA", + 'GEO_ICON': "GEO_ICON", 'IMAGE': "IMAGE", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_setting.py b/gooddata-api-client/gooddata_api_client/model/declarative_setting.py index 68d5cc622..f939ceb71 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_setting.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_setting.py @@ -102,10 +102,10 @@ class DeclarativeSetting(ModelNormal): 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS': "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", 'MAX_ZOOM_LEVEL': "MAX_ZOOM_LEVEL", 'SORT_CASE_SENSITIVE': "SORT_CASE_SENSITIVE", + 'SORT_COLLATION': "SORT_COLLATION", 'METRIC_FORMAT_OVERRIDE': "METRIC_FORMAT_OVERRIDE", 'ENABLE_AI_ON_DATA': "ENABLE_AI_ON_DATA", 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE': "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - 'ENABLE_NULL_JOINS': "ENABLE_NULL_JOINS", 'EXPORT_CSV_CUSTOM_DELIMITER': "EXPORT_CSV_CUSTOM_DELIMITER", 'ENABLE_QUERY_TAGS': "ENABLE_QUERY_TAGS", 'RESTRICT_BASE_UI': "RESTRICT_BASE_UI", diff --git a/gooddata-api-client/gooddata_api_client/model/get_service_status_response.py b/gooddata-api-client/gooddata_api_client/model/get_service_status_response.py new file mode 100644 index 000000000..369c9f76a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/get_service_status_response.py @@ -0,0 +1,276 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.json_node import JsonNode + globals()['JsonNode'] = JsonNode + + +class GetServiceStatusResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status': (JsonNode,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status': 'status', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status, *args, **kwargs): # noqa: E501 + """GetServiceStatusResponse - a model defined in OpenAPI + + Args: + status (JsonNode): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status = status + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status, *args, **kwargs): # noqa: E501 + """GetServiceStatusResponse - a model defined in OpenAPI + + Args: + status (JsonNode): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status = status + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/insight_widget_descriptor.py b/gooddata-api-client/gooddata_api_client/model/insight_widget_descriptor.py new file mode 100644 index 000000000..d933983cf --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/insight_widget_descriptor.py @@ -0,0 +1,342 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.insight_widget_descriptor_all_of import InsightWidgetDescriptorAllOf + from gooddata_api_client.model.widget_descriptor import WidgetDescriptor + globals()['InsightWidgetDescriptorAllOf'] = InsightWidgetDescriptorAllOf + globals()['WidgetDescriptor'] = WidgetDescriptor + + +class InsightWidgetDescriptor(ModelComposed): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'title': (str,), # noqa: E501 + 'visualization_id': (str,), # noqa: E501 + 'widget_id': (str,), # noqa: E501 + 'widget_type': (str,), # noqa: E501 + 'result_id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + val = { + } + if not val: + return None + return {'widget_type': val} + + attribute_map = { + 'title': 'title', # noqa: E501 + 'visualization_id': 'visualizationId', # noqa: E501 + 'widget_id': 'widgetId', # noqa: E501 + 'widget_type': 'widgetType', # noqa: E501 + 'result_id': 'resultId', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """InsightWidgetDescriptor - a model defined in OpenAPI + + Keyword Args: + title (str): Widget title as displayed on the dashboard. + visualization_id (str): Visualization object ID referenced by this insight widget. + widget_id (str): Widget object ID. + widget_type (str): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + result_id (str): Signed result ID for this widget's cached execution result.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """InsightWidgetDescriptor - a model defined in OpenAPI + + Keyword Args: + title (str): Widget title as displayed on the dashboard. + visualization_id (str): Visualization object ID referenced by this insight widget. + widget_id (str): Widget object ID. + widget_type (str): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + result_id (str): Signed result ID for this widget's cached execution result.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + InsightWidgetDescriptorAllOf, + WidgetDescriptor, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/insight_widget_descriptor_all_of.py b/gooddata-api-client/gooddata_api_client/model/insight_widget_descriptor_all_of.py new file mode 100644 index 000000000..cb25bd554 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/insight_widget_descriptor_all_of.py @@ -0,0 +1,276 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class InsightWidgetDescriptorAllOf(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'result_id': (str,), # noqa: E501 + 'title': (str,), # noqa: E501 + 'visualization_id': (str,), # noqa: E501 + 'widget_id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'result_id': 'resultId', # noqa: E501 + 'title': 'title', # noqa: E501 + 'visualization_id': 'visualizationId', # noqa: E501 + 'widget_id': 'widgetId', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """InsightWidgetDescriptorAllOf - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + result_id (str): Signed result ID for this widget's cached execution result.. [optional] # noqa: E501 + title (str): Widget title as displayed on the dashboard.. [optional] # noqa: E501 + visualization_id (str): Visualization object ID referenced by this insight widget.. [optional] # noqa: E501 + widget_id (str): Widget object ID.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """InsightWidgetDescriptorAllOf - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + result_id (str): Signed result ID for this widget's cached execution result.. [optional] # noqa: E501 + title (str): Widget title as displayed on the dashboard.. [optional] # noqa: E501 + visualization_id (str): Visualization object ID referenced by this insight widget.. [optional] # noqa: E501 + widget_id (str): Widget object ID.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_label_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_label_out_attributes.py index cd8076347..f6ad600b6 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_label_out_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_label_out_attributes.py @@ -78,6 +78,7 @@ class JsonApiLabelOutAttributes(ModelNormal): 'GEO_LONGITUDE': "GEO_LONGITUDE", 'GEO_LATITUDE': "GEO_LATITUDE", 'GEO_AREA': "GEO_AREA", + 'GEO_ICON': "GEO_ICON", 'IMAGE': "IMAGE", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_in.py index 7e7e92d29..6f95fcd00 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_in.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_in.py @@ -96,9 +96,9 @@ def openapi_types(): """ lazy_import() return { - 'attributes': (JsonApiLlmProviderInAttributes,), # noqa: E501 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 + 'attributes': (JsonApiLlmProviderInAttributes,), # noqa: E501 } @cached_property @@ -107,9 +107,9 @@ def discriminator(): attribute_map = { - 'attributes': 'attributes', # noqa: E501 'id': 'id', # noqa: E501 'type': 'type', # noqa: E501 + 'attributes': 'attributes', # noqa: E501 } read_only_vars = { @@ -119,11 +119,10 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 + def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 """JsonApiLlmProviderIn - a model defined in OpenAPI Args: - attributes (JsonApiLlmProviderInAttributes): id (str): API identifier of an object Keyword Args: @@ -158,6 +157,7 @@ def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + attributes (JsonApiLlmProviderInAttributes): [optional] # noqa: E501 """ type = kwargs.get('type', "llmProvider") @@ -190,7 +190,6 @@ def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.attributes = attributes self.id = id self.type = type for var_name, var_value in kwargs.items(): @@ -213,11 +212,10 @@ def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 + def __init__(self, id, *args, **kwargs): # noqa: E501 """JsonApiLlmProviderIn - a model defined in OpenAPI Args: - attributes (JsonApiLlmProviderInAttributes): id (str): API identifier of an object Keyword Args: @@ -252,6 +250,7 @@ def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + attributes (JsonApiLlmProviderInAttributes): [optional] # noqa: E501 """ type = kwargs.get('type', "llmProvider") @@ -282,7 +281,6 @@ def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.attributes = attributes self.id = id self.type = type for var_name, var_value in kwargs.items(): diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_in_attributes.py index 3425ffeda..9748a76c4 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_in_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_in_attributes.py @@ -99,11 +99,11 @@ def openapi_types(): """ lazy_import() return { - 'models': ([JsonApiLlmProviderInAttributesModelsInner], none_type,), # noqa: E501 - 'provider_config': (JsonApiLlmProviderInAttributesProviderConfig,), # noqa: E501 'default_model_id': (str, none_type,), # noqa: E501 'description': (str, none_type,), # noqa: E501 + 'models': ([JsonApiLlmProviderInAttributesModelsInner], none_type,), # noqa: E501 'name': (str, none_type,), # noqa: E501 + 'provider_config': (JsonApiLlmProviderInAttributesProviderConfig,), # noqa: E501 } @cached_property @@ -112,11 +112,11 @@ def discriminator(): attribute_map = { - 'models': 'models', # noqa: E501 - 'provider_config': 'providerConfig', # noqa: E501 'default_model_id': 'defaultModelId', # noqa: E501 'description': 'description', # noqa: E501 + 'models': 'models', # noqa: E501 'name': 'name', # noqa: E501 + 'provider_config': 'providerConfig', # noqa: E501 } read_only_vars = { @@ -126,13 +126,9 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, models, provider_config, *args, **kwargs): # noqa: E501 + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 """JsonApiLlmProviderInAttributes - a model defined in OpenAPI - Args: - models ([JsonApiLlmProviderInAttributesModelsInner], none_type): List of LLM models available for this provider. - provider_config (JsonApiLlmProviderInAttributesProviderConfig): - Keyword Args: _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be @@ -164,9 +160,11 @@ def _from_openapi_data(cls, models, provider_config, *args, **kwargs): # noqa: Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - default_model_id (str, none_type): ID of the default model to use from the models list.. [optional] # noqa: E501 + default_model_id (str, none_type): Required ID of the default model to use from the models list.. [optional] # noqa: E501 description (str, none_type): Description of the LLM Provider.. [optional] # noqa: E501 + models ([JsonApiLlmProviderInAttributesModelsInner], none_type): List of LLM models available for this provider.. [optional] # noqa: E501 name (str, none_type): [optional] # noqa: E501 + provider_config (JsonApiLlmProviderInAttributesProviderConfig): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -198,8 +196,6 @@ def _from_openapi_data(cls, models, provider_config, *args, **kwargs): # noqa: self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.models = models - self.provider_config = provider_config for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -220,13 +216,9 @@ def _from_openapi_data(cls, models, provider_config, *args, **kwargs): # noqa: ]) @convert_js_args_to_python_args - def __init__(self, models, provider_config, *args, **kwargs): # noqa: E501 + def __init__(self, *args, **kwargs): # noqa: E501 """JsonApiLlmProviderInAttributes - a model defined in OpenAPI - Args: - models ([JsonApiLlmProviderInAttributesModelsInner], none_type): List of LLM models available for this provider. - provider_config (JsonApiLlmProviderInAttributesProviderConfig): - Keyword Args: _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be @@ -258,9 +250,11 @@ def __init__(self, models, provider_config, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - default_model_id (str, none_type): ID of the default model to use from the models list.. [optional] # noqa: E501 + default_model_id (str, none_type): Required ID of the default model to use from the models list.. [optional] # noqa: E501 description (str, none_type): Description of the LLM Provider.. [optional] # noqa: E501 + models ([JsonApiLlmProviderInAttributesModelsInner], none_type): List of LLM models available for this provider.. [optional] # noqa: E501 name (str, none_type): [optional] # noqa: E501 + provider_config (JsonApiLlmProviderInAttributesProviderConfig): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -290,8 +284,6 @@ def __init__(self, models, provider_config, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.models = models - self.provider_config = provider_config for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_in_attributes_models_inner.py b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_in_attributes_models_inner.py index 0ff9244c7..acb64eb2c 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_in_attributes_models_inner.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_in_attributes_models_inner.py @@ -64,6 +64,7 @@ class JsonApiLlmProviderInAttributesModelsInner(ModelNormal): 'AMAZON': "AMAZON", 'GOOGLE': "GOOGLE", 'COHERE': "COHERE", + 'UNKNOWN': "UNKNOWN", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_in_attributes_provider_config.py b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_in_attributes_provider_config.py index 949c97b2a..c37b32b2a 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_in_attributes_provider_config.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_in_attributes_provider_config.py @@ -95,7 +95,7 @@ def additional_properties_type(): lazy_import() return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - _nullable = False + _nullable = True @cached_property def openapi_types(): @@ -109,7 +109,7 @@ def openapi_types(): """ lazy_import() return { - 'base_url': (str, none_type,), # noqa: E501 + 'base_url': (str,), # noqa: E501 'organization': (str, none_type,), # noqa: E501 'auth': (OpenAiProviderAuth,), # noqa: E501 'region': (str,), # noqa: E501 @@ -170,12 +170,12 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - base_url (str, none_type): Custom base URL for OpenAI API.. [optional] if omitted the server will use the default value of "https://api.openai.com" # noqa: E501 + base_url (str): Custom base URL for OpenAI API.. [optional] if omitted the server will use the default value of "https://api.openai.com/v1" # noqa: E501 organization (str, none_type): OpenAI organization ID.. [optional] # noqa: E501 auth (OpenAiProviderAuth): [optional] # noqa: E501 region (str): AWS region for Bedrock.. [optional] # noqa: E501 type (str): Provider type.. [optional] if omitted the server will use the default value of "OPENAI" # noqa: E501 - endpoint (str): Azure AI inference endpoint URL.. [optional] # noqa: E501 + endpoint (str): Azure OpenAI endpoint URL.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -279,12 +279,12 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - base_url (str, none_type): Custom base URL for OpenAI API.. [optional] if omitted the server will use the default value of "https://api.openai.com" # noqa: E501 + base_url (str): Custom base URL for OpenAI API.. [optional] if omitted the server will use the default value of "https://api.openai.com/v1" # noqa: E501 organization (str, none_type): OpenAI organization ID.. [optional] # noqa: E501 auth (OpenAiProviderAuth): [optional] # noqa: E501 region (str): AWS region for Bedrock.. [optional] # noqa: E501 type (str): Provider type.. [optional] if omitted the server will use the default value of "OPENAI" # noqa: E501 - endpoint (str): Azure AI inference endpoint URL.. [optional] # noqa: E501 + endpoint (str): Azure OpenAI endpoint URL.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_out.py index c90290459..2888c5928 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_out.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_out.py @@ -96,9 +96,9 @@ def openapi_types(): """ lazy_import() return { - 'attributes': (JsonApiLlmProviderInAttributes,), # noqa: E501 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 + 'attributes': (JsonApiLlmProviderInAttributes,), # noqa: E501 } @cached_property @@ -107,9 +107,9 @@ def discriminator(): attribute_map = { - 'attributes': 'attributes', # noqa: E501 'id': 'id', # noqa: E501 'type': 'type', # noqa: E501 + 'attributes': 'attributes', # noqa: E501 } read_only_vars = { @@ -119,11 +119,10 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 + def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 """JsonApiLlmProviderOut - a model defined in OpenAPI Args: - attributes (JsonApiLlmProviderInAttributes): id (str): API identifier of an object Keyword Args: @@ -158,6 +157,7 @@ def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + attributes (JsonApiLlmProviderInAttributes): [optional] # noqa: E501 """ type = kwargs.get('type', "llmProvider") @@ -190,7 +190,6 @@ def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.attributes = attributes self.id = id self.type = type for var_name, var_value in kwargs.items(): @@ -213,11 +212,10 @@ def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 + def __init__(self, id, *args, **kwargs): # noqa: E501 """JsonApiLlmProviderOut - a model defined in OpenAPI Args: - attributes (JsonApiLlmProviderInAttributes): id (str): API identifier of an object Keyword Args: @@ -252,6 +250,7 @@ def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + attributes (JsonApiLlmProviderInAttributes): [optional] # noqa: E501 """ type = kwargs.get('type', "llmProvider") @@ -282,7 +281,6 @@ def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.attributes = attributes self.id = id self.type = type for var_name, var_value in kwargs.items(): diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_out_with_links.py index 04eaadf61..fe998f54f 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_out_with_links.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_out_with_links.py @@ -102,9 +102,9 @@ def openapi_types(): """ lazy_import() return { - 'attributes': (JsonApiLlmProviderInAttributes,), # noqa: E501 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 + 'attributes': (JsonApiLlmProviderInAttributes,), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 } @@ -114,9 +114,9 @@ def discriminator(): attribute_map = { - 'attributes': 'attributes', # noqa: E501 'id': 'id', # noqa: E501 'type': 'type', # noqa: E501 + 'attributes': 'attributes', # noqa: E501 'links': 'links', # noqa: E501 } @@ -129,7 +129,6 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 """JsonApiLlmProviderOutWithLinks - a model defined in OpenAPI Keyword Args: - attributes (JsonApiLlmProviderInAttributes): id (str): API identifier of an object type (str): Object type. defaults to "llmProvider", must be one of ["llmProvider", ] # noqa: E501 _check_type (bool): if True, values for parameters in openapi_types @@ -162,6 +161,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + attributes (JsonApiLlmProviderInAttributes): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 """ @@ -237,7 +237,6 @@ def __init__(self, *args, **kwargs): # noqa: E501 """JsonApiLlmProviderOutWithLinks - a model defined in OpenAPI Keyword Args: - attributes (JsonApiLlmProviderInAttributes): id (str): API identifier of an object type (str): Object type. defaults to "llmProvider", must be one of ["llmProvider", ] # noqa: E501 _check_type (bool): if True, values for parameters in openapi_types @@ -270,6 +269,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + attributes (JsonApiLlmProviderInAttributes): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_patch.py index d594e2772..fcfd53eb2 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_patch.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_patch.py @@ -31,8 +31,8 @@ def lazy_import(): - from gooddata_api_client.model.json_api_llm_provider_patch_attributes import JsonApiLlmProviderPatchAttributes - globals()['JsonApiLlmProviderPatchAttributes'] = JsonApiLlmProviderPatchAttributes + from gooddata_api_client.model.json_api_llm_provider_in_attributes import JsonApiLlmProviderInAttributes + globals()['JsonApiLlmProviderInAttributes'] = JsonApiLlmProviderInAttributes class JsonApiLlmProviderPatch(ModelNormal): @@ -96,9 +96,9 @@ def openapi_types(): """ lazy_import() return { - 'attributes': (JsonApiLlmProviderPatchAttributes,), # noqa: E501 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 + 'attributes': (JsonApiLlmProviderInAttributes,), # noqa: E501 } @cached_property @@ -107,9 +107,9 @@ def discriminator(): attribute_map = { - 'attributes': 'attributes', # noqa: E501 'id': 'id', # noqa: E501 'type': 'type', # noqa: E501 + 'attributes': 'attributes', # noqa: E501 } read_only_vars = { @@ -119,11 +119,10 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 + def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 """JsonApiLlmProviderPatch - a model defined in OpenAPI Args: - attributes (JsonApiLlmProviderPatchAttributes): id (str): API identifier of an object Keyword Args: @@ -158,6 +157,7 @@ def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + attributes (JsonApiLlmProviderInAttributes): [optional] # noqa: E501 """ type = kwargs.get('type', "llmProvider") @@ -190,7 +190,6 @@ def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.attributes = attributes self.id = id self.type = type for var_name, var_value in kwargs.items(): @@ -213,11 +212,10 @@ def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 + def __init__(self, id, *args, **kwargs): # noqa: E501 """JsonApiLlmProviderPatch - a model defined in OpenAPI Args: - attributes (JsonApiLlmProviderPatchAttributes): id (str): API identifier of an object Keyword Args: @@ -252,6 +250,7 @@ def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + attributes (JsonApiLlmProviderInAttributes): [optional] # noqa: E501 """ type = kwargs.get('type', "llmProvider") @@ -282,7 +281,6 @@ def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.attributes = attributes self.id = id self.type = type for var_name, var_value in kwargs.items(): diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_document.py index 80593a1b9..431b8101e 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_document.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_document.py @@ -32,10 +32,10 @@ def lazy_import(): from gooddata_api_client.model.json_api_metric_out import JsonApiMetricOut - from gooddata_api_client.model.json_api_metric_out_includes import JsonApiMetricOutIncludes + from gooddata_api_client.model.json_api_visualization_object_out_includes import JsonApiVisualizationObjectOutIncludes from gooddata_api_client.model.object_links import ObjectLinks globals()['JsonApiMetricOut'] = JsonApiMetricOut - globals()['JsonApiMetricOutIncludes'] = JsonApiMetricOutIncludes + globals()['JsonApiVisualizationObjectOutIncludes'] = JsonApiVisualizationObjectOutIncludes globals()['ObjectLinks'] = ObjectLinks @@ -95,7 +95,7 @@ def openapi_types(): lazy_import() return { 'data': (JsonApiMetricOut,), # noqa: E501 - 'included': ([JsonApiMetricOutIncludes],), # noqa: E501 + 'included': ([JsonApiVisualizationObjectOutIncludes],), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 } @@ -154,7 +154,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - included ([JsonApiMetricOutIncludes]): Included resources. [optional] # noqa: E501 + included ([JsonApiVisualizationObjectOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 """ @@ -245,7 +245,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - included ([JsonApiMetricOutIncludes]): Included resources. [optional] # noqa: E501 + included ([JsonApiVisualizationObjectOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_list.py index 7e38c3294..b13fff666 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_list.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_list.py @@ -32,12 +32,12 @@ def lazy_import(): from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_metric_out_includes import JsonApiMetricOutIncludes from gooddata_api_client.model.json_api_metric_out_with_links import JsonApiMetricOutWithLinks + from gooddata_api_client.model.json_api_visualization_object_out_includes import JsonApiVisualizationObjectOutIncludes from gooddata_api_client.model.list_links import ListLinks globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiMetricOutIncludes'] = JsonApiMetricOutIncludes globals()['JsonApiMetricOutWithLinks'] = JsonApiMetricOutWithLinks + globals()['JsonApiVisualizationObjectOutIncludes'] = JsonApiVisualizationObjectOutIncludes globals()['ListLinks'] = ListLinks @@ -99,7 +99,7 @@ def openapi_types(): lazy_import() return { 'data': ([JsonApiMetricOutWithLinks],), # noqa: E501 - 'included': ([JsonApiMetricOutIncludes],), # noqa: E501 + 'included': ([JsonApiVisualizationObjectOutIncludes],), # noqa: E501 'links': (ListLinks,), # noqa: E501 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 } @@ -160,7 +160,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - included ([JsonApiMetricOutIncludes]): Included resources. [optional] # noqa: E501 + included ([JsonApiVisualizationObjectOutIncludes]): Included resources. [optional] # noqa: E501 links (ListLinks): [optional] # noqa: E501 meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 """ @@ -252,7 +252,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - included ([JsonApiMetricOutIncludes]): Included resources. [optional] # noqa: E501 + included ([JsonApiVisualizationObjectOutIncludes]): Included resources. [optional] # noqa: E501 links (ListLinks): [optional] # noqa: E501 meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_in_attributes.py index d431d8652..3839580ad 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_in_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_in_attributes.py @@ -98,10 +98,10 @@ class JsonApiOrganizationSettingInAttributes(ModelNormal): 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS': "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", 'MAX_ZOOM_LEVEL': "MAX_ZOOM_LEVEL", 'SORT_CASE_SENSITIVE': "SORT_CASE_SENSITIVE", + 'SORT_COLLATION': "SORT_COLLATION", 'METRIC_FORMAT_OVERRIDE': "METRIC_FORMAT_OVERRIDE", 'ENABLE_AI_ON_DATA': "ENABLE_AI_ON_DATA", 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE': "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - 'ENABLE_NULL_JOINS': "ENABLE_NULL_JOINS", 'EXPORT_CSV_CUSTOM_DELIMITER': "EXPORT_CSV_CUSTOM_DELIMITER", 'ENABLE_QUERY_TAGS': "ENABLE_QUERY_TAGS", 'RESTRICT_BASE_UI': "RESTRICT_BASE_UI", diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_document.py index 60ba9cea1..7ce8ac539 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_document.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_document.py @@ -31,11 +31,11 @@ def lazy_import(): - from gooddata_api_client.model.json_api_metric_out_includes import JsonApiMetricOutIncludes from gooddata_api_client.model.json_api_visualization_object_out import JsonApiVisualizationObjectOut + from gooddata_api_client.model.json_api_visualization_object_out_includes import JsonApiVisualizationObjectOutIncludes from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiMetricOutIncludes'] = JsonApiMetricOutIncludes globals()['JsonApiVisualizationObjectOut'] = JsonApiVisualizationObjectOut + globals()['JsonApiVisualizationObjectOutIncludes'] = JsonApiVisualizationObjectOutIncludes globals()['ObjectLinks'] = ObjectLinks @@ -95,7 +95,7 @@ def openapi_types(): lazy_import() return { 'data': (JsonApiVisualizationObjectOut,), # noqa: E501 - 'included': ([JsonApiMetricOutIncludes],), # noqa: E501 + 'included': ([JsonApiVisualizationObjectOutIncludes],), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 } @@ -154,7 +154,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - included ([JsonApiMetricOutIncludes]): Included resources. [optional] # noqa: E501 + included ([JsonApiVisualizationObjectOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 """ @@ -245,7 +245,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - included ([JsonApiMetricOutIncludes]): Included resources. [optional] # noqa: E501 + included ([JsonApiVisualizationObjectOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_includes.py b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_includes.py similarity index 98% rename from gooddata-api-client/gooddata_api_client/model/json_api_metric_out_includes.py rename to gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_includes.py index cc941bc44..bbdfa74e1 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_includes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_includes.py @@ -53,7 +53,7 @@ def lazy_import(): globals()['ObjectLinks'] = ObjectLinks -class JsonApiMetricOutIncludes(ModelComposed): +class JsonApiVisualizationObjectOutIncludes(ModelComposed): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -142,7 +142,7 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiMetricOutIncludes - a model defined in OpenAPI + """JsonApiVisualizationObjectOutIncludes - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -251,7 +251,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiMetricOutIncludes - a model defined in OpenAPI + """JsonApiVisualizationObjectOutIncludes - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_list.py index 55693b5f8..9e2091874 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_list.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_list.py @@ -32,11 +32,11 @@ def lazy_import(): from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta - from gooddata_api_client.model.json_api_metric_out_includes import JsonApiMetricOutIncludes + from gooddata_api_client.model.json_api_visualization_object_out_includes import JsonApiVisualizationObjectOutIncludes from gooddata_api_client.model.json_api_visualization_object_out_with_links import JsonApiVisualizationObjectOutWithLinks from gooddata_api_client.model.list_links import ListLinks globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta - globals()['JsonApiMetricOutIncludes'] = JsonApiMetricOutIncludes + globals()['JsonApiVisualizationObjectOutIncludes'] = JsonApiVisualizationObjectOutIncludes globals()['JsonApiVisualizationObjectOutWithLinks'] = JsonApiVisualizationObjectOutWithLinks globals()['ListLinks'] = ListLinks @@ -99,7 +99,7 @@ def openapi_types(): lazy_import() return { 'data': ([JsonApiVisualizationObjectOutWithLinks],), # noqa: E501 - 'included': ([JsonApiMetricOutIncludes],), # noqa: E501 + 'included': ([JsonApiVisualizationObjectOutIncludes],), # noqa: E501 'links': (ListLinks,), # noqa: E501 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 } @@ -160,7 +160,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - included ([JsonApiMetricOutIncludes]): Included resources. [optional] # noqa: E501 + included ([JsonApiVisualizationObjectOutIncludes]): Included resources. [optional] # noqa: E501 links (ListLinks): [optional] # noqa: E501 meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 """ @@ -252,7 +252,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - included ([JsonApiMetricOutIncludes]): Included resources. [optional] # noqa: E501 + included ([JsonApiVisualizationObjectOutIncludes]): Included resources. [optional] # noqa: E501 links (ListLinks): [optional] # noqa: E501 meta (JsonApiAggregatedFactOutListMeta): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/key_drivers_dimension.py b/gooddata-api-client/gooddata_api_client/model/key_drivers_dimension.py index bb65f3599..b82cb63e5 100644 --- a/gooddata-api-client/gooddata_api_client/model/key_drivers_dimension.py +++ b/gooddata-api-client/gooddata_api_client/model/key_drivers_dimension.py @@ -90,6 +90,7 @@ class KeyDriversDimension(ModelNormal): 'GEO_LONGITUDE': "GEO_LONGITUDE", 'GEO_LATITUDE': "GEO_LATITUDE", 'GEO_AREA': "GEO_AREA", + 'GEO_ICON': "GEO_ICON", 'IMAGE': "IMAGE", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/list_llm_provider_models_request.py b/gooddata-api-client/gooddata_api_client/model/list_llm_provider_models_request.py new file mode 100644 index 000000000..c5e8668a1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/list_llm_provider_models_request.py @@ -0,0 +1,276 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.list_llm_provider_models_request_provider_config import ListLlmProviderModelsRequestProviderConfig + globals()['ListLlmProviderModelsRequestProviderConfig'] = ListLlmProviderModelsRequestProviderConfig + + +class ListLlmProviderModelsRequest(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'provider_config': (ListLlmProviderModelsRequestProviderConfig,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'provider_config': 'providerConfig', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, provider_config, *args, **kwargs): # noqa: E501 + """ListLlmProviderModelsRequest - a model defined in OpenAPI + + Args: + provider_config (ListLlmProviderModelsRequestProviderConfig): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.provider_config = provider_config + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, provider_config, *args, **kwargs): # noqa: E501 + """ListLlmProviderModelsRequest - a model defined in OpenAPI + + Args: + provider_config (ListLlmProviderModelsRequestProviderConfig): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.provider_config = provider_config + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/test_llm_provider_definition_request_provider_config.py b/gooddata-api-client/gooddata_api_client/model/list_llm_provider_models_request_provider_config.py similarity index 94% rename from gooddata-api-client/gooddata_api_client/model/test_llm_provider_definition_request_provider_config.py rename to gooddata-api-client/gooddata_api_client/model/list_llm_provider_models_request_provider_config.py index e93080b2c..21d26004d 100644 --- a/gooddata-api-client/gooddata_api_client/model/test_llm_provider_definition_request_provider_config.py +++ b/gooddata-api-client/gooddata_api_client/model/list_llm_provider_models_request_provider_config.py @@ -41,7 +41,7 @@ def lazy_import(): globals()['OpenAiProviderAuth'] = OpenAiProviderAuth -class TestLlmProviderDefinitionRequestProviderConfig(ModelComposed): +class ListLlmProviderModelsRequestProviderConfig(ModelComposed): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -109,7 +109,7 @@ def openapi_types(): """ lazy_import() return { - 'base_url': (str, none_type,), # noqa: E501 + 'base_url': (str,), # noqa: E501 'organization': (str, none_type,), # noqa: E501 'auth': (OpenAiProviderAuth,), # noqa: E501 'region': (str,), # noqa: E501 @@ -137,7 +137,7 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """TestLlmProviderDefinitionRequestProviderConfig - a model defined in OpenAPI + """ListLlmProviderModelsRequestProviderConfig - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -170,12 +170,12 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - base_url (str, none_type): Custom base URL for OpenAI API.. [optional] if omitted the server will use the default value of "https://api.openai.com" # noqa: E501 + base_url (str): Custom base URL for OpenAI API.. [optional] if omitted the server will use the default value of "https://api.openai.com/v1" # noqa: E501 organization (str, none_type): OpenAI organization ID.. [optional] # noqa: E501 auth (OpenAiProviderAuth): [optional] # noqa: E501 region (str): AWS region for Bedrock.. [optional] # noqa: E501 type (str): Provider type.. [optional] if omitted the server will use the default value of "OPENAI" # noqa: E501 - endpoint (str): Azure AI inference endpoint URL.. [optional] # noqa: E501 + endpoint (str): Azure OpenAI endpoint URL.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -246,7 +246,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """TestLlmProviderDefinitionRequestProviderConfig - a model defined in OpenAPI + """ListLlmProviderModelsRequestProviderConfig - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -279,12 +279,12 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - base_url (str, none_type): Custom base URL for OpenAI API.. [optional] if omitted the server will use the default value of "https://api.openai.com" # noqa: E501 + base_url (str): Custom base URL for OpenAI API.. [optional] if omitted the server will use the default value of "https://api.openai.com/v1" # noqa: E501 organization (str, none_type): OpenAI organization ID.. [optional] # noqa: E501 auth (OpenAiProviderAuth): [optional] # noqa: E501 region (str): AWS region for Bedrock.. [optional] # noqa: E501 type (str): Provider type.. [optional] if omitted the server will use the default value of "OPENAI" # noqa: E501 - endpoint (str): Azure AI inference endpoint URL.. [optional] # noqa: E501 + endpoint (str): Azure OpenAI endpoint URL.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/list_llm_provider_models_response.py b/gooddata-api-client/gooddata_api_client/model/list_llm_provider_models_response.py new file mode 100644 index 000000000..1a96206e6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/list_llm_provider_models_response.py @@ -0,0 +1,288 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.llm_model import LlmModel + globals()['LlmModel'] = LlmModel + + +class ListLlmProviderModelsResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'message': (str,), # noqa: E501 + 'models': ([LlmModel],), # noqa: E501 + 'success': (bool,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'message': 'message', # noqa: E501 + 'models': 'models', # noqa: E501 + 'success': 'success', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, message, models, success, *args, **kwargs): # noqa: E501 + """ListLlmProviderModelsResponse - a model defined in OpenAPI + + Args: + message (str): Message about the listing result. + models ([LlmModel]): Available models on the provider. + success (bool): Whether the model listing succeeded. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.message = message + self.models = models + self.success = success + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, message, models, success, *args, **kwargs): # noqa: E501 + """ListLlmProviderModelsResponse - a model defined in OpenAPI + + Args: + message (str): Message about the listing result. + models ([LlmModel]): Available models on the provider. + success (bool): Whether the model listing succeeded. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.message = message + self.models = models + self.success = success + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/llm_model.py b/gooddata-api-client/gooddata_api_client/model/llm_model.py index 575dd8d68..c5e9b848f 100644 --- a/gooddata-api-client/gooddata_api_client/model/llm_model.py +++ b/gooddata-api-client/gooddata_api_client/model/llm_model.py @@ -64,6 +64,7 @@ class LlmModel(ModelNormal): 'AMAZON': "AMAZON", 'GOOGLE': "GOOGLE", 'COHERE': "COHERE", + 'UNKNOWN': "UNKNOWN", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/llm_provider_config.py b/gooddata-api-client/gooddata_api_client/model/llm_provider_config.py index e18d277f1..2ed845ed4 100644 --- a/gooddata-api-client/gooddata_api_client/model/llm_provider_config.py +++ b/gooddata-api-client/gooddata_api_client/model/llm_provider_config.py @@ -109,7 +109,7 @@ def openapi_types(): """ lazy_import() return { - 'base_url': (str, none_type,), # noqa: E501 + 'base_url': (str,), # noqa: E501 'organization': (str, none_type,), # noqa: E501 'auth': (OpenAiProviderAuth,), # noqa: E501 'region': (str,), # noqa: E501 @@ -170,12 +170,12 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - base_url (str, none_type): Custom base URL for OpenAI API.. [optional] if omitted the server will use the default value of "https://api.openai.com" # noqa: E501 + base_url (str): Custom base URL for OpenAI API.. [optional] if omitted the server will use the default value of "https://api.openai.com/v1" # noqa: E501 organization (str, none_type): OpenAI organization ID.. [optional] # noqa: E501 auth (OpenAiProviderAuth): [optional] # noqa: E501 region (str): AWS region for Bedrock.. [optional] # noqa: E501 type (str): Provider type.. [optional] if omitted the server will use the default value of "OPENAI" # noqa: E501 - endpoint (str): Azure AI inference endpoint URL.. [optional] # noqa: E501 + endpoint (str): Azure OpenAI endpoint URL.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -279,12 +279,12 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - base_url (str, none_type): Custom base URL for OpenAI API.. [optional] if omitted the server will use the default value of "https://api.openai.com" # noqa: E501 + base_url (str): Custom base URL for OpenAI API.. [optional] if omitted the server will use the default value of "https://api.openai.com/v1" # noqa: E501 organization (str, none_type): OpenAI organization ID.. [optional] # noqa: E501 auth (OpenAiProviderAuth): [optional] # noqa: E501 region (str): AWS region for Bedrock.. [optional] # noqa: E501 type (str): Provider type.. [optional] if omitted the server will use the default value of "OPENAI" # noqa: E501 - endpoint (str): Azure AI inference endpoint URL.. [optional] # noqa: E501 + endpoint (str): Azure OpenAI endpoint URL.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/object_reference.py b/gooddata-api-client/gooddata_api_client/model/object_reference.py new file mode 100644 index 000000000..32c87649c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/object_reference.py @@ -0,0 +1,282 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class ObjectReference(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('type',): { + 'WIDGET': "WIDGET", + 'METRIC': "METRIC", + 'ATTRIBUTE': "ATTRIBUTE", + 'DASHBOARD': "DASHBOARD", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, type, *args, **kwargs): # noqa: E501 + """ObjectReference - a model defined in OpenAPI + + Args: + id (str): Object identifier (e.g. widget ID, metric ID). + type (str): Type of the referenced object. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, id, type, *args, **kwargs): # noqa: E501 + """ObjectReference - a model defined in OpenAPI + + Args: + id (str): Object identifier (e.g. widget ID, metric ID). + type (str): Type of the referenced object. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/object_reference_group.py b/gooddata-api-client/gooddata_api_client/model/object_reference_group.py new file mode 100644 index 000000000..498d76634 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/object_reference_group.py @@ -0,0 +1,280 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.object_reference import ObjectReference + globals()['ObjectReference'] = ObjectReference + + +class ObjectReferenceGroup(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'objects': ([ObjectReference],), # noqa: E501 + 'context': (ObjectReference,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'objects': 'objects', # noqa: E501 + 'context': 'context', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, objects, *args, **kwargs): # noqa: E501 + """ObjectReferenceGroup - a model defined in OpenAPI + + Args: + objects ([ObjectReference]): Objects the user explicitly referenced within this context. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + context (ObjectReference): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.objects = objects + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, objects, *args, **kwargs): # noqa: E501 + """ObjectReferenceGroup - a model defined in OpenAPI + + Args: + objects ([ObjectReference]): Objects the user explicitly referenced within this context. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + context (ObjectReference): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.objects = objects + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/open_ai_provider_config.py b/gooddata-api-client/gooddata_api_client/model/open_ai_provider_config.py index a1532e10d..34992608a 100644 --- a/gooddata-api-client/gooddata_api_client/model/open_ai_provider_config.py +++ b/gooddata-api-client/gooddata_api_client/model/open_ai_provider_config.py @@ -99,7 +99,7 @@ def openapi_types(): return { 'auth': (OpenAiProviderAuth,), # noqa: E501 'type': (str,), # noqa: E501 - 'base_url': (str, none_type,), # noqa: E501 + 'base_url': (str,), # noqa: E501 'organization': (str, none_type,), # noqa: E501 } @@ -160,7 +160,7 @@ def _from_openapi_data(cls, auth, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - base_url (str, none_type): Custom base URL for OpenAI API.. [optional] if omitted the server will use the default value of "https://api.openai.com" # noqa: E501 + base_url (str): Custom base URL for OpenAI API.. [optional] if omitted the server will use the default value of "https://api.openai.com/v1" # noqa: E501 organization (str, none_type): OpenAI organization ID.. [optional] # noqa: E501 """ @@ -254,7 +254,7 @@ def __init__(self, auth, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - base_url (str, none_type): Custom base URL for OpenAI API.. [optional] if omitted the server will use the default value of "https://api.openai.com" # noqa: E501 + base_url (str): Custom base URL for OpenAI API.. [optional] if omitted the server will use the default value of "https://api.openai.com/v1" # noqa: E501 organization (str, none_type): OpenAI organization ID.. [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/resolved_setting.py b/gooddata-api-client/gooddata_api_client/model/resolved_setting.py index a5b88bc0a..9cb6b0a59 100644 --- a/gooddata-api-client/gooddata_api_client/model/resolved_setting.py +++ b/gooddata-api-client/gooddata_api_client/model/resolved_setting.py @@ -102,10 +102,10 @@ class ResolvedSetting(ModelNormal): 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS': "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", 'MAX_ZOOM_LEVEL': "MAX_ZOOM_LEVEL", 'SORT_CASE_SENSITIVE': "SORT_CASE_SENSITIVE", + 'SORT_COLLATION': "SORT_COLLATION", 'METRIC_FORMAT_OVERRIDE': "METRIC_FORMAT_OVERRIDE", 'ENABLE_AI_ON_DATA': "ENABLE_AI_ON_DATA", 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE': "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - 'ENABLE_NULL_JOINS': "ENABLE_NULL_JOINS", 'EXPORT_CSV_CUSTOM_DELIMITER': "EXPORT_CSV_CUSTOM_DELIMITER", 'ENABLE_QUERY_TAGS': "ENABLE_QUERY_TAGS", 'RESTRICT_BASE_UI': "RESTRICT_BASE_UI", diff --git a/gooddata-api-client/gooddata_api_client/model/rich_text_widget_descriptor.py b/gooddata-api-client/gooddata_api_client/model/rich_text_widget_descriptor.py new file mode 100644 index 000000000..7ba548ee4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/rich_text_widget_descriptor.py @@ -0,0 +1,334 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.rich_text_widget_descriptor_all_of import RichTextWidgetDescriptorAllOf + from gooddata_api_client.model.widget_descriptor import WidgetDescriptor + globals()['RichTextWidgetDescriptorAllOf'] = RichTextWidgetDescriptorAllOf + globals()['WidgetDescriptor'] = WidgetDescriptor + + +class RichTextWidgetDescriptor(ModelComposed): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'title': (str,), # noqa: E501 + 'widget_id': (str,), # noqa: E501 + 'widget_type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + val = { + } + if not val: + return None + return {'widget_type': val} + + attribute_map = { + 'title': 'title', # noqa: E501 + 'widget_id': 'widgetId', # noqa: E501 + 'widget_type': 'widgetType', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """RichTextWidgetDescriptor - a model defined in OpenAPI + + Keyword Args: + title (str): Widget title as displayed on the dashboard. + widget_id (str): Widget object ID. + widget_type (str): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """RichTextWidgetDescriptor - a model defined in OpenAPI + + Keyword Args: + title (str): Widget title as displayed on the dashboard. + widget_id (str): Widget object ID. + widget_type (str): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + RichTextWidgetDescriptorAllOf, + WidgetDescriptor, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/rich_text_widget_descriptor_all_of.py b/gooddata-api-client/gooddata_api_client/model/rich_text_widget_descriptor_all_of.py new file mode 100644 index 000000000..2fe02853d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/rich_text_widget_descriptor_all_of.py @@ -0,0 +1,268 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class RichTextWidgetDescriptorAllOf(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'title': (str,), # noqa: E501 + 'widget_id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'title': 'title', # noqa: E501 + 'widget_id': 'widgetId', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """RichTextWidgetDescriptorAllOf - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + title (str): Widget title as displayed on the dashboard.. [optional] # noqa: E501 + widget_id (str): Widget object ID.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """RichTextWidgetDescriptorAllOf - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + title (str): Widget title as displayed on the dashboard.. [optional] # noqa: E501 + widget_id (str): Widget object ID.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/settings.py b/gooddata-api-client/gooddata_api_client/model/settings.py index ba78d874e..d986a29b2 100644 --- a/gooddata-api-client/gooddata_api_client/model/settings.py +++ b/gooddata-api-client/gooddata_api_client/model/settings.py @@ -60,6 +60,12 @@ class Settings(ModelNormal): """ allowed_values = { + ('grand_totals_position',): { + 'PINNEDBOTTOM': "pinnedBottom", + 'PINNEDTOP': "pinnedTop", + 'BOTTOM': "bottom", + 'TOP': "top", + }, ('page_orientation',): { 'PORTRAIT': "PORTRAIT", 'LANDSCAPE': "LANDSCAPE", @@ -106,6 +112,7 @@ def openapi_types(): return { 'delimiter': (str,), # noqa: E501 'export_info': (bool,), # noqa: E501 + 'grand_totals_position': (str,), # noqa: E501 'merge_headers': (bool,), # noqa: E501 'page_orientation': (str,), # noqa: E501 'page_size': (str,), # noqa: E501 @@ -124,6 +131,7 @@ def discriminator(): attribute_map = { 'delimiter': 'delimiter', # noqa: E501 'export_info': 'exportInfo', # noqa: E501 + 'grand_totals_position': 'grandTotalsPosition', # noqa: E501 'merge_headers': 'mergeHeaders', # noqa: E501 'page_orientation': 'pageOrientation', # noqa: E501 'page_size': 'pageSize', # noqa: E501 @@ -177,6 +185,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) delimiter (str): Set column delimiter. (CSV). [optional] # noqa: E501 export_info (bool): If true, the export will contain the information about the export – exported date, filters, etc. Works only with `visualizationObject`. (XLSX, PDF). [optional] if omitted the server will use the default value of False # noqa: E501 + grand_totals_position (str): Grand totals position. Takes precedence over position specified in visualization.. [optional] # noqa: E501 merge_headers (bool): Merge equal headers in neighbouring cells. (XLSX). [optional] # noqa: E501 page_orientation (str): Set page orientation. (PDF). [optional] if omitted the server will use the default value of "PORTRAIT" # noqa: E501 page_size (str): Set page size. (PDF). [optional] if omitted the server will use the default value of "A4" # noqa: E501 @@ -272,6 +281,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) delimiter (str): Set column delimiter. (CSV). [optional] # noqa: E501 export_info (bool): If true, the export will contain the information about the export – exported date, filters, etc. Works only with `visualizationObject`. (XLSX, PDF). [optional] if omitted the server will use the default value of False # noqa: E501 + grand_totals_position (str): Grand totals position. Takes precedence over position specified in visualization.. [optional] # noqa: E501 merge_headers (bool): Merge equal headers in neighbouring cells. (XLSX). [optional] # noqa: E501 page_orientation (str): Set page orientation. (PDF). [optional] if omitted the server will use the default value of "PORTRAIT" # noqa: E501 page_size (str): Set page size. (PDF). [optional] if omitted the server will use the default value of "A4" # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_patch_attributes.py b/gooddata-api-client/gooddata_api_client/model/test_llm_provider_by_id_request.py similarity index 81% rename from gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_patch_attributes.py rename to gooddata-api-client/gooddata_api_client/model/test_llm_provider_by_id_request.py index 64f5ee3fc..1cd1a741f 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_patch_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/test_llm_provider_by_id_request.py @@ -31,13 +31,13 @@ def lazy_import(): - from gooddata_api_client.model.json_api_llm_provider_in_attributes_models_inner import JsonApiLlmProviderInAttributesModelsInner - from gooddata_api_client.model.json_api_llm_provider_in_attributes_provider_config import JsonApiLlmProviderInAttributesProviderConfig - globals()['JsonApiLlmProviderInAttributesModelsInner'] = JsonApiLlmProviderInAttributesModelsInner - globals()['JsonApiLlmProviderInAttributesProviderConfig'] = JsonApiLlmProviderInAttributesProviderConfig + from gooddata_api_client.model.list_llm_provider_models_request_provider_config import ListLlmProviderModelsRequestProviderConfig + from gooddata_api_client.model.llm_model import LlmModel + globals()['ListLlmProviderModelsRequestProviderConfig'] = ListLlmProviderModelsRequestProviderConfig + globals()['LlmModel'] = LlmModel -class JsonApiLlmProviderPatchAttributes(ModelNormal): +class TestLlmProviderByIdRequest(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -65,15 +65,6 @@ class JsonApiLlmProviderPatchAttributes(ModelNormal): } validations = { - ('default_model_id',): { - 'max_length': 255, - }, - ('description',): { - 'max_length': 10000, - }, - ('name',): { - 'max_length': 255, - }, } @cached_property @@ -99,11 +90,8 @@ def openapi_types(): """ lazy_import() return { - 'default_model_id': (str, none_type,), # noqa: E501 - 'description': (str, none_type,), # noqa: E501 - 'models': ([JsonApiLlmProviderInAttributesModelsInner], none_type,), # noqa: E501 - 'name': (str, none_type,), # noqa: E501 - 'provider_config': (JsonApiLlmProviderInAttributesProviderConfig,), # noqa: E501 + 'models': ([LlmModel],), # noqa: E501 + 'provider_config': (ListLlmProviderModelsRequestProviderConfig,), # noqa: E501 } @cached_property @@ -112,10 +100,7 @@ def discriminator(): attribute_map = { - 'default_model_id': 'defaultModelId', # noqa: E501 - 'description': 'description', # noqa: E501 'models': 'models', # noqa: E501 - 'name': 'name', # noqa: E501 'provider_config': 'providerConfig', # noqa: E501 } @@ -127,7 +112,7 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiLlmProviderPatchAttributes - a model defined in OpenAPI + """TestLlmProviderByIdRequest - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -160,11 +145,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - default_model_id (str, none_type): ID of the default model to use from the models list.. [optional] # noqa: E501 - description (str, none_type): Description of the LLM Provider.. [optional] # noqa: E501 - models ([JsonApiLlmProviderInAttributesModelsInner], none_type): List of LLM models available for this provider.. [optional] # noqa: E501 - name (str, none_type): [optional] # noqa: E501 - provider_config (JsonApiLlmProviderInAttributesProviderConfig): [optional] # noqa: E501 + models ([LlmModel]): Models overrides.. [optional] # noqa: E501 + provider_config (ListLlmProviderModelsRequestProviderConfig): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -217,7 +199,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiLlmProviderPatchAttributes - a model defined in OpenAPI + """TestLlmProviderByIdRequest - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -250,11 +232,8 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - default_model_id (str, none_type): ID of the default model to use from the models list.. [optional] # noqa: E501 - description (str, none_type): Description of the LLM Provider.. [optional] # noqa: E501 - models ([JsonApiLlmProviderInAttributesModelsInner], none_type): List of LLM models available for this provider.. [optional] # noqa: E501 - name (str, none_type): [optional] # noqa: E501 - provider_config (JsonApiLlmProviderInAttributesProviderConfig): [optional] # noqa: E501 + models ([LlmModel]): Models overrides.. [optional] # noqa: E501 + provider_config (ListLlmProviderModelsRequestProviderConfig): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/test_llm_provider_definition_request.py b/gooddata-api-client/gooddata_api_client/model/test_llm_provider_definition_request.py index d1ebb7f5f..72ffbb70c 100644 --- a/gooddata-api-client/gooddata_api_client/model/test_llm_provider_definition_request.py +++ b/gooddata-api-client/gooddata_api_client/model/test_llm_provider_definition_request.py @@ -31,10 +31,10 @@ def lazy_import(): + from gooddata_api_client.model.list_llm_provider_models_request_provider_config import ListLlmProviderModelsRequestProviderConfig from gooddata_api_client.model.llm_model import LlmModel - from gooddata_api_client.model.test_llm_provider_definition_request_provider_config import TestLlmProviderDefinitionRequestProviderConfig + globals()['ListLlmProviderModelsRequestProviderConfig'] = ListLlmProviderModelsRequestProviderConfig globals()['LlmModel'] = LlmModel - globals()['TestLlmProviderDefinitionRequestProviderConfig'] = TestLlmProviderDefinitionRequestProviderConfig class TestLlmProviderDefinitionRequest(ModelNormal): @@ -90,7 +90,7 @@ def openapi_types(): """ lazy_import() return { - 'provider_config': (TestLlmProviderDefinitionRequestProviderConfig,), # noqa: E501 + 'provider_config': (ListLlmProviderModelsRequestProviderConfig,), # noqa: E501 'models': ([LlmModel],), # noqa: E501 } @@ -115,7 +115,7 @@ def _from_openapi_data(cls, provider_config, *args, **kwargs): # noqa: E501 """TestLlmProviderDefinitionRequest - a model defined in OpenAPI Args: - provider_config (TestLlmProviderDefinitionRequestProviderConfig): + provider_config (ListLlmProviderModelsRequestProviderConfig): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -205,7 +205,7 @@ def __init__(self, provider_config, *args, **kwargs): # noqa: E501 """TestLlmProviderDefinitionRequest - a model defined in OpenAPI Args: - provider_config (TestLlmProviderDefinitionRequestProviderConfig): + provider_config (ListLlmProviderModelsRequestProviderConfig): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types diff --git a/gooddata-api-client/gooddata_api_client/model/trending_object_item.py b/gooddata-api-client/gooddata_api_client/model/trending_object_item.py new file mode 100644 index 000000000..8b6f7ccfc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/trending_object_item.py @@ -0,0 +1,348 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class TrendingObjectItem(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'tags': ([str],), # noqa: E501 + 'title': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'usage_count': (int,), # noqa: E501 + 'workspace_id': (str,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + 'created_by': (str,), # noqa: E501 + 'dataset_id': (str,), # noqa: E501 + 'dataset_title': (str,), # noqa: E501 + 'dataset_type': (str,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'is_hidden': (bool,), # noqa: E501 + 'is_hidden_from_kda': (bool,), # noqa: E501 + 'metric_type': (str,), # noqa: E501 + 'modified_at': (datetime,), # noqa: E501 + 'modified_by': (str,), # noqa: E501 + 'visualization_url': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'tags': 'tags', # noqa: E501 + 'title': 'title', # noqa: E501 + 'type': 'type', # noqa: E501 + 'usage_count': 'usageCount', # noqa: E501 + 'workspace_id': 'workspaceId', # noqa: E501 + 'created_at': 'createdAt', # noqa: E501 + 'created_by': 'createdBy', # noqa: E501 + 'dataset_id': 'datasetId', # noqa: E501 + 'dataset_title': 'datasetTitle', # noqa: E501 + 'dataset_type': 'datasetType', # noqa: E501 + 'description': 'description', # noqa: E501 + 'is_hidden': 'isHidden', # noqa: E501 + 'is_hidden_from_kda': 'isHiddenFromKda', # noqa: E501 + 'metric_type': 'metricType', # noqa: E501 + 'modified_at': 'modifiedAt', # noqa: E501 + 'modified_by': 'modifiedBy', # noqa: E501 + 'visualization_url': 'visualizationUrl', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, tags, title, type, usage_count, workspace_id, *args, **kwargs): # noqa: E501 + """TrendingObjectItem - a model defined in OpenAPI + + Args: + id (str): Object ID. + tags ([str]): + title (str): Object title. + type (str): Object type, e.g. dashboard, visualization, metric. + usage_count (int): Number of times this object has been used/referenced. + workspace_id (str): Workspace ID the object belongs to. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + created_at (datetime): Timestamp when object was created.. [optional] # noqa: E501 + created_by (str): ID of the user who created the object.. [optional] # noqa: E501 + dataset_id (str): ID of the associated dataset, if applicable.. [optional] # noqa: E501 + dataset_title (str): Title of the associated dataset, if applicable.. [optional] # noqa: E501 + dataset_type (str): Type of the associated dataset, if applicable.. [optional] # noqa: E501 + description (str): Object description.. [optional] # noqa: E501 + is_hidden (bool): If true, this object is hidden from AI search results by default.. [optional] # noqa: E501 + is_hidden_from_kda (bool): If true, this object is hidden from KDA.. [optional] # noqa: E501 + metric_type (str): Type of the metric (e.g. MAQL), if applicable.. [optional] # noqa: E501 + modified_at (datetime): Timestamp when object was last modified.. [optional] # noqa: E501 + modified_by (str): ID of the user who last modified the object.. [optional] # noqa: E501 + visualization_url (str): URL of the visualization, if applicable.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + self.tags = tags + self.title = title + self.type = type + self.usage_count = usage_count + self.workspace_id = workspace_id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, id, tags, title, type, usage_count, workspace_id, *args, **kwargs): # noqa: E501 + """TrendingObjectItem - a model defined in OpenAPI + + Args: + id (str): Object ID. + tags ([str]): + title (str): Object title. + type (str): Object type, e.g. dashboard, visualization, metric. + usage_count (int): Number of times this object has been used/referenced. + workspace_id (str): Workspace ID the object belongs to. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + created_at (datetime): Timestamp when object was created.. [optional] # noqa: E501 + created_by (str): ID of the user who created the object.. [optional] # noqa: E501 + dataset_id (str): ID of the associated dataset, if applicable.. [optional] # noqa: E501 + dataset_title (str): Title of the associated dataset, if applicable.. [optional] # noqa: E501 + dataset_type (str): Type of the associated dataset, if applicable.. [optional] # noqa: E501 + description (str): Object description.. [optional] # noqa: E501 + is_hidden (bool): If true, this object is hidden from AI search results by default.. [optional] # noqa: E501 + is_hidden_from_kda (bool): If true, this object is hidden from KDA.. [optional] # noqa: E501 + metric_type (str): Type of the metric (e.g. MAQL), if applicable.. [optional] # noqa: E501 + modified_at (datetime): Timestamp when object was last modified.. [optional] # noqa: E501 + modified_by (str): ID of the user who last modified the object.. [optional] # noqa: E501 + visualization_url (str): URL of the visualization, if applicable.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + self.tags = tags + self.title = title + self.type = type + self.usage_count = usage_count + self.workspace_id = workspace_id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/trending_objects_result.py b/gooddata-api-client/gooddata_api_client/model/trending_objects_result.py new file mode 100644 index 000000000..1154733fa --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/trending_objects_result.py @@ -0,0 +1,276 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.trending_object_item import TrendingObjectItem + globals()['TrendingObjectItem'] = TrendingObjectItem + + +class TrendingObjectsResult(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'objects': ([TrendingObjectItem],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'objects': 'objects', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, objects, *args, **kwargs): # noqa: E501 + """TrendingObjectsResult - a model defined in OpenAPI + + Args: + objects ([TrendingObjectItem]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.objects = objects + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, objects, *args, **kwargs): # noqa: E501 + """TrendingObjectsResult - a model defined in OpenAPI + + Args: + objects ([TrendingObjectItem]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.objects = objects + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/ui_context.py b/gooddata-api-client/gooddata_api_client/model/ui_context.py new file mode 100644 index 000000000..f92c03bf9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/ui_context.py @@ -0,0 +1,270 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.dashboard_context import DashboardContext + globals()['DashboardContext'] = DashboardContext + + +class UIContext(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'dashboard': (DashboardContext,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'dashboard': 'dashboard', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """UIContext - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + dashboard (DashboardContext): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """UIContext - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + dashboard (DashboardContext): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/user_context.py b/gooddata-api-client/gooddata_api_client/model/user_context.py index d31d32383..536cab6f5 100644 --- a/gooddata-api-client/gooddata_api_client/model/user_context.py +++ b/gooddata-api-client/gooddata_api_client/model/user_context.py @@ -32,7 +32,11 @@ def lazy_import(): from gooddata_api_client.model.active_object_identification import ActiveObjectIdentification + from gooddata_api_client.model.object_reference_group import ObjectReferenceGroup + from gooddata_api_client.model.ui_context import UIContext globals()['ActiveObjectIdentification'] = ActiveObjectIdentification + globals()['ObjectReferenceGroup'] = ObjectReferenceGroup + globals()['UIContext'] = UIContext class UserContext(ModelNormal): @@ -88,7 +92,9 @@ def openapi_types(): """ lazy_import() return { + 'referenced_objects': ([ObjectReferenceGroup],), # noqa: E501 'active_object': (ActiveObjectIdentification,), # noqa: E501 + 'view': (UIContext,), # noqa: E501 } @cached_property @@ -97,7 +103,9 @@ def discriminator(): attribute_map = { + 'referenced_objects': 'referencedObjects', # noqa: E501 'active_object': 'activeObject', # noqa: E501 + 'view': 'view', # noqa: E501 } read_only_vars = { @@ -107,11 +115,11 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, active_object, *args, **kwargs): # noqa: E501 + def _from_openapi_data(cls, referenced_objects, *args, **kwargs): # noqa: E501 """UserContext - a model defined in OpenAPI Args: - active_object (ActiveObjectIdentification): + referenced_objects ([ObjectReferenceGroup]): Groups of explicitly referenced objects, each optionally scoped by a context (e.g. a dashboard context with widget references). Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -144,6 +152,8 @@ def _from_openapi_data(cls, active_object, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + active_object (ActiveObjectIdentification): [optional] # noqa: E501 + view (UIContext): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -175,7 +185,7 @@ def _from_openapi_data(cls, active_object, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.active_object = active_object + self.referenced_objects = referenced_objects for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -196,11 +206,11 @@ def _from_openapi_data(cls, active_object, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, active_object, *args, **kwargs): # noqa: E501 + def __init__(self, referenced_objects, *args, **kwargs): # noqa: E501 """UserContext - a model defined in OpenAPI Args: - active_object (ActiveObjectIdentification): + referenced_objects ([ObjectReferenceGroup]): Groups of explicitly referenced objects, each optionally scoped by a context (e.g. a dashboard context with widget references). Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -233,6 +243,8 @@ def __init__(self, active_object, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + active_object (ActiveObjectIdentification): [optional] # noqa: E501 + view (UIContext): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -262,7 +274,7 @@ def __init__(self, active_object, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.active_object = active_object + self.referenced_objects = referenced_objects for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/gooddata-api-client/gooddata_api_client/model/visualization_switcher_widget_descriptor.py b/gooddata-api-client/gooddata_api_client/model/visualization_switcher_widget_descriptor.py new file mode 100644 index 000000000..785a017b5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/visualization_switcher_widget_descriptor.py @@ -0,0 +1,346 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.visualization_switcher_widget_descriptor_all_of import VisualizationSwitcherWidgetDescriptorAllOf + from gooddata_api_client.model.widget_descriptor import WidgetDescriptor + globals()['VisualizationSwitcherWidgetDescriptorAllOf'] = VisualizationSwitcherWidgetDescriptorAllOf + globals()['WidgetDescriptor'] = WidgetDescriptor + + +class VisualizationSwitcherWidgetDescriptor(ModelComposed): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'active_visualization_id': (str,), # noqa: E501 + 'title': (str,), # noqa: E501 + 'visualization_ids': ([str],), # noqa: E501 + 'widget_id': (str,), # noqa: E501 + 'widget_type': (str,), # noqa: E501 + 'result_id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + val = { + } + if not val: + return None + return {'widget_type': val} + + attribute_map = { + 'active_visualization_id': 'activeVisualizationId', # noqa: E501 + 'title': 'title', # noqa: E501 + 'visualization_ids': 'visualizationIds', # noqa: E501 + 'widget_id': 'widgetId', # noqa: E501 + 'widget_type': 'widgetType', # noqa: E501 + 'result_id': 'resultId', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """VisualizationSwitcherWidgetDescriptor - a model defined in OpenAPI + + Keyword Args: + active_visualization_id (str): ID of the currently active visualization in the switcher. + title (str): Widget title as displayed on the dashboard. + visualization_ids ([str]): IDs of all visualizations available in the switcher. + widget_id (str): Widget object ID. + widget_type (str): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + result_id (str): Signed result ID for the currently active visualization's execution result.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """VisualizationSwitcherWidgetDescriptor - a model defined in OpenAPI + + Keyword Args: + active_visualization_id (str): ID of the currently active visualization in the switcher. + title (str): Widget title as displayed on the dashboard. + visualization_ids ([str]): IDs of all visualizations available in the switcher. + widget_id (str): Widget object ID. + widget_type (str): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + result_id (str): Signed result ID for the currently active visualization's execution result.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + VisualizationSwitcherWidgetDescriptorAllOf, + WidgetDescriptor, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/visualization_switcher_widget_descriptor_all_of.py b/gooddata-api-client/gooddata_api_client/model/visualization_switcher_widget_descriptor_all_of.py new file mode 100644 index 000000000..2f49e776b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/visualization_switcher_widget_descriptor_all_of.py @@ -0,0 +1,280 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class VisualizationSwitcherWidgetDescriptorAllOf(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'active_visualization_id': (str,), # noqa: E501 + 'result_id': (str,), # noqa: E501 + 'title': (str,), # noqa: E501 + 'visualization_ids': ([str],), # noqa: E501 + 'widget_id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'active_visualization_id': 'activeVisualizationId', # noqa: E501 + 'result_id': 'resultId', # noqa: E501 + 'title': 'title', # noqa: E501 + 'visualization_ids': 'visualizationIds', # noqa: E501 + 'widget_id': 'widgetId', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """VisualizationSwitcherWidgetDescriptorAllOf - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + active_visualization_id (str): ID of the currently active visualization in the switcher.. [optional] # noqa: E501 + result_id (str): Signed result ID for the currently active visualization's execution result.. [optional] # noqa: E501 + title (str): Widget title as displayed on the dashboard.. [optional] # noqa: E501 + visualization_ids ([str]): IDs of all visualizations available in the switcher.. [optional] # noqa: E501 + widget_id (str): Widget object ID.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """VisualizationSwitcherWidgetDescriptorAllOf - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + active_visualization_id (str): ID of the currently active visualization in the switcher.. [optional] # noqa: E501 + result_id (str): Signed result ID for the currently active visualization's execution result.. [optional] # noqa: E501 + title (str): Widget title as displayed on the dashboard.. [optional] # noqa: E501 + visualization_ids ([str]): IDs of all visualizations available in the switcher.. [optional] # noqa: E501 + widget_id (str): Widget object ID.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/widget_descriptor.py b/gooddata-api-client/gooddata_api_client/model/widget_descriptor.py new file mode 100644 index 000000000..c4c1cc396 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/widget_descriptor.py @@ -0,0 +1,299 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.insight_widget_descriptor import InsightWidgetDescriptor + from gooddata_api_client.model.rich_text_widget_descriptor import RichTextWidgetDescriptor + from gooddata_api_client.model.visualization_switcher_widget_descriptor import VisualizationSwitcherWidgetDescriptor + globals()['InsightWidgetDescriptor'] = InsightWidgetDescriptor + globals()['RichTextWidgetDescriptor'] = RichTextWidgetDescriptor + globals()['VisualizationSwitcherWidgetDescriptor'] = VisualizationSwitcherWidgetDescriptor + + +class WidgetDescriptor(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'title': (str,), # noqa: E501 + 'widget_id': (str,), # noqa: E501 + 'widget_type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + lazy_import() + val = { + 'insight': InsightWidgetDescriptor, + 'richText': RichTextWidgetDescriptor, + 'visualizationSwitcher': VisualizationSwitcherWidgetDescriptor, + } + if not val: + return None + return {'widget_type': val} + + attribute_map = { + 'title': 'title', # noqa: E501 + 'widget_id': 'widgetId', # noqa: E501 + 'widget_type': 'widgetType', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, title, widget_id, widget_type, *args, **kwargs): # noqa: E501 + """WidgetDescriptor - a model defined in OpenAPI + + Args: + title (str): + widget_id (str): + widget_type (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.title = title + self.widget_id = widget_id + self.widget_type = widget_type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, title, widget_id, widget_type, *args, **kwargs): # noqa: E501 + """WidgetDescriptor - a model defined in OpenAPI + + Args: + title (str): + widget_id (str): + widget_type (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.title = title + self.widget_id = widget_id + self.widget_type = widget_type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/models/__init__.py b/gooddata-api-client/gooddata_api_client/models/__init__.py index 29f009645..927f19741 100644 --- a/gooddata-api-client/gooddata_api_client/models/__init__.py +++ b/gooddata-api-client/gooddata_api_client/models/__init__.py @@ -186,6 +186,8 @@ from gooddata_api_client.model.custom_override import CustomOverride from gooddata_api_client.model.dashboard_attribute_filter import DashboardAttributeFilter from gooddata_api_client.model.dashboard_attribute_filter_attribute_filter import DashboardAttributeFilterAttributeFilter +from gooddata_api_client.model.dashboard_context import DashboardContext +from gooddata_api_client.model.dashboard_context_widgets_inner import DashboardContextWidgetsInner from gooddata_api_client.model.dashboard_date_filter import DashboardDateFilter from gooddata_api_client.model.dashboard_date_filter_date_filter import DashboardDateFilterDateFilter from gooddata_api_client.model.dashboard_export_settings import DashboardExportSettings @@ -360,6 +362,7 @@ from gooddata_api_client.model.get_ai_lake_operation200_response import GetAiLakeOperation200Response from gooddata_api_client.model.get_image_export202_response_inner import GetImageExport202ResponseInner from gooddata_api_client.model.get_quality_issues_response import GetQualityIssuesResponse +from gooddata_api_client.model.get_service_status_response import GetServiceStatusResponse from gooddata_api_client.model.grain_identifier import GrainIdentifier from gooddata_api_client.model.granted_permission import GrantedPermission from gooddata_api_client.model.granularities_formatting import GranularitiesFormatting @@ -378,6 +381,8 @@ from gooddata_api_client.model.inline_filter_definition_inline import InlineFilterDefinitionInline from gooddata_api_client.model.inline_measure_definition import InlineMeasureDefinition from gooddata_api_client.model.inline_measure_definition_inline import InlineMeasureDefinitionInline +from gooddata_api_client.model.insight_widget_descriptor import InsightWidgetDescriptor +from gooddata_api_client.model.insight_widget_descriptor_all_of import InsightWidgetDescriptorAllOf from gooddata_api_client.model.intro_slide_template import IntroSlideTemplate from gooddata_api_client.model.json_api_aggregated_fact_linkage import JsonApiAggregatedFactLinkage from gooddata_api_client.model.json_api_aggregated_fact_out import JsonApiAggregatedFactOut @@ -750,7 +755,6 @@ from gooddata_api_client.model.json_api_llm_provider_out_list import JsonApiLlmProviderOutList from gooddata_api_client.model.json_api_llm_provider_out_with_links import JsonApiLlmProviderOutWithLinks from gooddata_api_client.model.json_api_llm_provider_patch import JsonApiLlmProviderPatch -from gooddata_api_client.model.json_api_llm_provider_patch_attributes import JsonApiLlmProviderPatchAttributes from gooddata_api_client.model.json_api_llm_provider_patch_document import JsonApiLlmProviderPatchDocument from gooddata_api_client.model.json_api_memory_item_in import JsonApiMemoryItemIn from gooddata_api_client.model.json_api_memory_item_in_attributes import JsonApiMemoryItemInAttributes @@ -773,7 +777,6 @@ from gooddata_api_client.model.json_api_metric_out import JsonApiMetricOut from gooddata_api_client.model.json_api_metric_out_attributes import JsonApiMetricOutAttributes from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument -from gooddata_api_client.model.json_api_metric_out_includes import JsonApiMetricOutIncludes from gooddata_api_client.model.json_api_metric_out_list import JsonApiMetricOutList from gooddata_api_client.model.json_api_metric_out_relationships import JsonApiMetricOutRelationships from gooddata_api_client.model.json_api_metric_out_with_links import JsonApiMetricOutWithLinks @@ -898,6 +901,7 @@ from gooddata_api_client.model.json_api_visualization_object_out import JsonApiVisualizationObjectOut from gooddata_api_client.model.json_api_visualization_object_out_attributes import JsonApiVisualizationObjectOutAttributes from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.model.json_api_visualization_object_out_includes import JsonApiVisualizationObjectOutIncludes from gooddata_api_client.model.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList from gooddata_api_client.model.json_api_visualization_object_out_with_links import JsonApiVisualizationObjectOutWithLinks from gooddata_api_client.model.json_api_visualization_object_patch import JsonApiVisualizationObjectPatch @@ -980,6 +984,9 @@ from gooddata_api_client.model.list_knowledge_documents_response_dto import ListKnowledgeDocumentsResponseDto from gooddata_api_client.model.list_links import ListLinks from gooddata_api_client.model.list_links_all_of import ListLinksAllOf +from gooddata_api_client.model.list_llm_provider_models_request import ListLlmProviderModelsRequest +from gooddata_api_client.model.list_llm_provider_models_request_provider_config import ListLlmProviderModelsRequestProviderConfig +from gooddata_api_client.model.list_llm_provider_models_response import ListLlmProviderModelsResponse from gooddata_api_client.model.list_services_response import ListServicesResponse from gooddata_api_client.model.llm_model import LlmModel from gooddata_api_client.model.llm_provider_auth import LlmProviderAuth @@ -1019,6 +1026,8 @@ from gooddata_api_client.model.notifications_meta_total import NotificationsMetaTotal from gooddata_api_client.model.object_links import ObjectLinks from gooddata_api_client.model.object_links_container import ObjectLinksContainer +from gooddata_api_client.model.object_reference import ObjectReference +from gooddata_api_client.model.object_reference_group import ObjectReferenceGroup from gooddata_api_client.model.open_ai_provider_config import OpenAIProviderConfig from gooddata_api_client.model.open_ai_api_key_auth import OpenAiApiKeyAuth from gooddata_api_client.model.open_ai_api_key_auth_all_of import OpenAiApiKeyAuthAllOf @@ -1091,6 +1100,8 @@ from gooddata_api_client.model.result_dimension import ResultDimension from gooddata_api_client.model.result_dimension_header import ResultDimensionHeader from gooddata_api_client.model.result_spec import ResultSpec +from gooddata_api_client.model.rich_text_widget_descriptor import RichTextWidgetDescriptor +from gooddata_api_client.model.rich_text_widget_descriptor_all_of import RichTextWidgetDescriptorAllOf from gooddata_api_client.model.route_result import RouteResult from gooddata_api_client.model.rsa_specification import RsaSpecification from gooddata_api_client.model.rule_permission import RulePermission @@ -1139,8 +1150,8 @@ from gooddata_api_client.model.tabular_export_request import TabularExportRequest from gooddata_api_client.model.test_definition_request import TestDefinitionRequest from gooddata_api_client.model.test_destination_request import TestDestinationRequest +from gooddata_api_client.model.test_llm_provider_by_id_request import TestLlmProviderByIdRequest from gooddata_api_client.model.test_llm_provider_definition_request import TestLlmProviderDefinitionRequest -from gooddata_api_client.model.test_llm_provider_definition_request_provider_config import TestLlmProviderDefinitionRequestProviderConfig from gooddata_api_client.model.test_llm_provider_response import TestLlmProviderResponse from gooddata_api_client.model.test_notification import TestNotification from gooddata_api_client.model.test_notification_all_of import TestNotificationAllOf @@ -1152,8 +1163,11 @@ from gooddata_api_client.model.total_dimension import TotalDimension from gooddata_api_client.model.total_execution_result_header import TotalExecutionResultHeader from gooddata_api_client.model.total_result_header import TotalResultHeader +from gooddata_api_client.model.trending_object_item import TrendingObjectItem +from gooddata_api_client.model.trending_objects_result import TrendingObjectsResult from gooddata_api_client.model.trigger_automation_request import TriggerAutomationRequest from gooddata_api_client.model.trigger_quality_issues_calculation_response import TriggerQualityIssuesCalculationResponse +from gooddata_api_client.model.ui_context import UIContext from gooddata_api_client.model.upsert_knowledge_document_request_dto import UpsertKnowledgeDocumentRequestDto from gooddata_api_client.model.upsert_knowledge_document_response_dto import UpsertKnowledgeDocumentResponseDto from gooddata_api_client.model.user_assignee import UserAssignee @@ -1179,6 +1193,8 @@ from gooddata_api_client.model.visible_filter import VisibleFilter from gooddata_api_client.model.visual_export_request import VisualExportRequest from gooddata_api_client.model.visualization_config import VisualizationConfig +from gooddata_api_client.model.visualization_switcher_widget_descriptor import VisualizationSwitcherWidgetDescriptor +from gooddata_api_client.model.visualization_switcher_widget_descriptor_all_of import VisualizationSwitcherWidgetDescriptorAllOf from gooddata_api_client.model.webhook import Webhook from gooddata_api_client.model.webhook_all_of import WebhookAllOf from gooddata_api_client.model.webhook_automation_info import WebhookAutomationInfo @@ -1188,6 +1204,7 @@ from gooddata_api_client.model.what_if_measure_adjustment_config import WhatIfMeasureAdjustmentConfig from gooddata_api_client.model.what_if_scenario_config import WhatIfScenarioConfig from gooddata_api_client.model.what_if_scenario_item import WhatIfScenarioItem +from gooddata_api_client.model.widget_descriptor import WidgetDescriptor from gooddata_api_client.model.widget_slides_template import WidgetSlidesTemplate from gooddata_api_client.model.workspace_automation_identifier import WorkspaceAutomationIdentifier from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest diff --git a/schemas/gooddata-afm-client.json b/schemas/gooddata-afm-client.json index f7d41eb58..718e33d92 100644 --- a/schemas/gooddata-afm-client.json +++ b/schemas/gooddata-afm-client.json @@ -839,6 +839,7 @@ "GEO_LONGITUDE", "GEO_LATITUDE", "GEO_AREA", + "GEO_ICON", "IMAGE" ], "type": "string" @@ -1066,8 +1067,8 @@ "$ref": "#/components/schemas/AzureFoundryProviderAuth" }, "endpoint": { - "description": "Azure AI inference endpoint URL.", - "example": "https://my-resource.services.ai.azure.com/models", + "description": "Azure OpenAI endpoint URL.", + "example": "https://my-resource.openai.azure.com", "maxLength": 255, "type": "string" }, @@ -1997,6 +1998,37 @@ ], "type": "object" }, + "DashboardContext": { + "description": "Dashboard the user is currently viewing.", + "properties": { + "id": { + "description": "Dashboard object ID.", + "type": "string" + }, + "widgets": { + "description": "Widgets currently visible on the dashboard.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/InsightWidgetDescriptor" + }, + { + "$ref": "#/components/schemas/RichTextWidgetDescriptor" + }, + { + "$ref": "#/components/schemas/VisualizationSwitcherWidgetDescriptor" + } + ] + }, + "type": "array" + } + }, + "required": [ + "id", + "widgets" + ], + "type": "object" + }, "DataColumnLocator": { "description": "Mapping from dimension items (either 'localIdentifier' from 'AttributeItem', or \"measureGroup\") to their respective values. This effectively specifies the path (location) of the data column used for sorting. Therefore values for all dimension items must be specified.", "example": { @@ -3075,6 +3107,18 @@ ], "type": "object" }, + "GetServiceStatusResponse": { + "description": "Status of an AI Lake service", + "properties": { + "status": { + "$ref": "#/components/schemas/JsonNode" + } + }, + "required": [ + "status" + ], + "type": "object" + }, "HeaderGroup": { "description": "Contains the information specific for a group of headers. These groups correlate to attributes and metric groups.", "properties": { @@ -3139,6 +3183,41 @@ ], "type": "object" }, + "InsightWidgetDescriptor": { + "allOf": [ + { + "$ref": "#/components/schemas/WidgetDescriptor" + }, + { + "properties": { + "resultId": { + "description": "Signed result ID for this widget's cached execution result.", + "type": "string" + }, + "title": { + "description": "Widget title as displayed on the dashboard.", + "type": "string" + }, + "visualizationId": { + "description": "Visualization object ID referenced by this insight widget.", + "type": "string" + }, + "widgetId": { + "description": "Widget object ID.", + "type": "string" + } + }, + "type": "object" + } + ], + "description": "Insight widget displaying a visualization.", + "required": [ + "title", + "visualizationId", + "widgetId" + ], + "type": "object" + }, "JsonNode": { "description": "The payload to pass to the command", "nullable": true, @@ -3193,6 +3272,7 @@ "GEO_LONGITUDE", "GEO_LATITUDE", "GEO_AREA", + "GEO_ICON", "IMAGE" ], "type": "string" @@ -3403,6 +3483,52 @@ ], "type": "object" }, + "ListLlmProviderModelsRequest": { + "properties": { + "providerConfig": { + "oneOf": [ + { + "$ref": "#/components/schemas/AwsBedrockProviderConfig" + }, + { + "$ref": "#/components/schemas/AzureFoundryProviderConfig" + }, + { + "$ref": "#/components/schemas/OpenAIProviderConfig" + } + ] + } + }, + "required": [ + "providerConfig" + ], + "type": "object" + }, + "ListLlmProviderModelsResponse": { + "properties": { + "message": { + "description": "Message about the listing result.", + "type": "string" + }, + "models": { + "description": "Available models on the provider.", + "items": { + "$ref": "#/components/schemas/LlmModel" + }, + "type": "array" + }, + "success": { + "description": "Whether the model listing succeeded.", + "type": "boolean" + } + }, + "required": [ + "message", + "models", + "success" + ], + "type": "object" + }, "ListServicesResponse": { "description": "Paged response for listing AI Lake services", "properties": { @@ -3436,7 +3562,8 @@ "MISTRAL", "AMAZON", "GOOGLE", - "COHERE" + "COHERE", + "UNKNOWN" ], "type": "string" }, @@ -3453,7 +3580,7 @@ "type": "object" }, "LlmProviderConfig": { - "description": "Provider configuration to test.", + "description": "Provider configuration overrides.", "oneOf": [ { "$ref": "#/components/schemas/AwsBedrockProviderConfig" @@ -3865,6 +3992,47 @@ ], "type": "object" }, + "ObjectReference": { + "properties": { + "id": { + "description": "Object identifier (e.g. widget ID, metric ID).", + "type": "string" + }, + "type": { + "description": "Type of the referenced object.", + "enum": [ + "WIDGET", + "METRIC", + "ATTRIBUTE", + "DASHBOARD" + ], + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "ObjectReferenceGroup": { + "properties": { + "context": { + "$ref": "#/components/schemas/ObjectReference" + }, + "objects": { + "description": "Objects the user explicitly referenced within this context.", + "items": { + "$ref": "#/components/schemas/ObjectReference" + }, + "type": "array" + } + }, + "required": [ + "objects" + ], + "type": "object" + }, "OpenAIProviderConfig": { "description": "Configuration for OpenAI provider.", "properties": { @@ -3872,10 +4040,9 @@ "$ref": "#/components/schemas/OpenAiProviderAuth" }, "baseUrl": { - "default": "https://api.openai.com", + "default": "https://api.openai.com/v1", "description": "Custom base URL for OpenAI API.", "maxLength": 255, - "nullable": true, "type": "string" }, "organization": { @@ -4832,6 +4999,32 @@ ], "type": "object" }, + "RichTextWidgetDescriptor": { + "allOf": [ + { + "$ref": "#/components/schemas/WidgetDescriptor" + }, + { + "properties": { + "title": { + "description": "Widget title as displayed on the dashboard.", + "type": "string" + }, + "widgetId": { + "description": "Widget object ID.", + "type": "string" + } + }, + "type": "object" + } + ], + "description": "Rich text widget displaying static content. Has no execution result.", + "required": [ + "title", + "widgetId" + ], + "type": "object" + }, "RouteResult": { "description": "Question -> Use Case routing. May contain final answer is a special use case is not required.", "properties": { @@ -5404,6 +5597,31 @@ ], "type": "object" }, + "TestLlmProviderByIdRequest": { + "properties": { + "models": { + "description": "Models overrides.", + "items": { + "$ref": "#/components/schemas/LlmModel" + }, + "type": "array" + }, + "providerConfig": { + "oneOf": [ + { + "$ref": "#/components/schemas/AwsBedrockProviderConfig" + }, + { + "$ref": "#/components/schemas/AzureFoundryProviderConfig" + }, + { + "$ref": "#/components/schemas/OpenAIProviderConfig" + } + ] + } + }, + "type": "object" + }, "TestLlmProviderDefinitionRequest": { "properties": { "models": { @@ -5560,6 +5778,112 @@ ], "type": "object" }, + "TrendingObjectItem": { + "description": "Trending analytics catalog objects", + "properties": { + "createdAt": { + "description": "Timestamp when object was created.", + "format": "date-time", + "type": "string" + }, + "createdBy": { + "description": "ID of the user who created the object.", + "type": "string" + }, + "datasetId": { + "description": "ID of the associated dataset, if applicable.", + "type": "string" + }, + "datasetTitle": { + "description": "Title of the associated dataset, if applicable.", + "type": "string" + }, + "datasetType": { + "description": "Type of the associated dataset, if applicable.", + "type": "string" + }, + "description": { + "description": "Object description.", + "type": "string" + }, + "id": { + "description": "Object ID.", + "type": "string" + }, + "isHidden": { + "description": "If true, this object is hidden from AI search results by default.", + "type": "boolean" + }, + "isHiddenFromKda": { + "description": "If true, this object is hidden from KDA.", + "type": "boolean" + }, + "metricType": { + "description": "Type of the metric (e.g. MAQL), if applicable.", + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when object was last modified.", + "format": "date-time", + "type": "string" + }, + "modifiedBy": { + "description": "ID of the user who last modified the object.", + "type": "string" + }, + "tags": { + "items": { + "description": "Tags assigned to the object.", + "type": "string" + }, + "type": "array" + }, + "title": { + "description": "Object title.", + "type": "string" + }, + "type": { + "description": "Object type, e.g. dashboard, visualization, metric.", + "type": "string" + }, + "usageCount": { + "description": "Number of times this object has been used/referenced.", + "format": "int32", + "type": "integer" + }, + "visualizationUrl": { + "description": "URL of the visualization, if applicable.", + "type": "string" + }, + "workspaceId": { + "description": "Workspace ID the object belongs to.", + "type": "string" + } + }, + "required": [ + "id", + "tags", + "title", + "type", + "usageCount", + "workspaceId" + ], + "type": "object" + }, + "TrendingObjectsResult": { + "properties": { + "objects": { + "items": { + "$ref": "#/components/schemas/TrendingObjectItem" + }, + "type": "array" + } + }, + "required": [ + "objects" + ], + "type": "object" + }, "TriggerQualityIssuesCalculationResponse": { "properties": { "processId": { @@ -5584,6 +5908,15 @@ ], "type": "object" }, + "UIContext": { + "description": "Ambient UI state: what the user is currently looking at (dashboard, visible widgets).", + "properties": { + "dashboard": { + "$ref": "#/components/schemas/DashboardContext" + } + }, + "type": "object" + }, "Unit": { "type": "object" }, @@ -5643,14 +5976,24 @@ "type": "object" }, "UserContext": { - "description": "User context, which can affect the behavior of the underlying AI features.", + "description": "User context with ambient UI state (view) and explicitly referenced objects.", "properties": { "activeObject": { "$ref": "#/components/schemas/ActiveObjectIdentification" + }, + "referencedObjects": { + "description": "Groups of explicitly referenced objects, each optionally scoped by a context (e.g. a dashboard context with widget references).", + "items": { + "$ref": "#/components/schemas/ObjectReferenceGroup" + }, + "type": "array" + }, + "view": { + "$ref": "#/components/schemas/UIContext" } }, "required": [ - "activeObject" + "referencedObjects" ], "type": "object" }, @@ -5762,6 +6105,49 @@ }, "type": "object" }, + "VisualizationSwitcherWidgetDescriptor": { + "allOf": [ + { + "$ref": "#/components/schemas/WidgetDescriptor" + }, + { + "properties": { + "activeVisualizationId": { + "description": "ID of the currently active visualization in the switcher.", + "type": "string" + }, + "resultId": { + "description": "Signed result ID for the currently active visualization's execution result.", + "type": "string" + }, + "title": { + "description": "Widget title as displayed on the dashboard.", + "type": "string" + }, + "visualizationIds": { + "description": "IDs of all visualizations available in the switcher.", + "items": { + "type": "string" + }, + "type": "array" + }, + "widgetId": { + "description": "Widget object ID.", + "type": "string" + } + }, + "type": "object" + } + ], + "description": "Visualization switcher widget allowing users to toggle between multiple visualizations.", + "required": [ + "activeVisualizationId", + "title", + "visualizationIds", + "widgetId" + ], + "type": "object" + }, "WhatIfMeasureAdjustmentConfig": { "description": "Measure adjustments for this scenario", "properties": { @@ -5826,6 +6212,34 @@ "label" ], "type": "object" + }, + "WidgetDescriptor": { + "description": "Descriptor for a widget on the dashboard.", + "discriminator": { + "mapping": { + "insight": "#/components/schemas/InsightWidgetDescriptor", + "richText": "#/components/schemas/RichTextWidgetDescriptor", + "visualizationSwitcher": "#/components/schemas/VisualizationSwitcherWidgetDescriptor" + }, + "propertyName": "widgetType" + }, + "properties": { + "title": { + "type": "string" + }, + "widgetId": { + "type": "string" + }, + "widgetType": { + "type": "string" + } + }, + "required": [ + "title", + "widgetId", + "widgetType" + ], + "type": "object" } } }, @@ -5910,6 +6324,39 @@ ] } }, + "/api/v1/actions/ai/llmProvider/listModels": { + "post": { + "description": "Lists models available on an LLM provider with a full definition. For Azure AI Foundry providers, the model family will be set to UNKNOWN because the endpoint does not expose the family.", + "operationId": "listLlmProviderModels", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListLlmProviderModelsRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListLlmProviderModelsResponse" + } + } + }, + "description": "OK" + } + }, + "summary": "List LLM Provider Models", + "tags": [ + "Smart Functions", + "actions" + ] + } + }, "/api/v1/actions/ai/llmProvider/test": { "post": { "description": "Tests LLM provider connectivity with a full definition.", @@ -5943,6 +6390,39 @@ ] } }, + "/api/v1/actions/ai/llmProvider/{llmProviderId}/listModels": { + "post": { + "description": "Lists models available on an existing LLM provider by its ID. For Azure AI Foundry providers, the model family will be set to UNKNOWN because the endpoint does not expose the family.", + "operationId": "listLlmProviderModelsById", + "parameters": [ + { + "in": "path", + "name": "llmProviderId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListLlmProviderModelsResponse" + } + } + }, + "description": "OK" + } + }, + "summary": "List LLM Provider Models By Id", + "tags": [ + "Smart Functions", + "actions" + ] + } + }, "/api/v1/actions/ai/llmProvider/{llmProviderId}/test": { "post": { "description": "Tests an existing LLM provider connectivity by its ID.", @@ -5957,6 +6437,15 @@ } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TestLlmProviderByIdRequest" + } + } + } + }, "responses": { "200": { "content": { @@ -6136,6 +6625,41 @@ ] } }, + "/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/trendingObjects": { + "get": { + "description": "Returns a list of trending objects for this workspace", + "operationId": "trendingObjects", + "parameters": [ + { + "description": "Workspace identifier", + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TrendingObjectsResult" + } + } + }, + "description": "OK" + } + }, + "summary": "Get Trending Analytics Catalog Objects", + "tags": [ + "Smart Functions", + "actions" + ] + } + }, "/api/v1/actions/workspaces/{workspaceId}/ai/chat": { "post": { "description": "(BETA) Combines multiple use cases such as search, create visualizations, ...", @@ -6472,6 +6996,22 @@ "schema": { "type": "string" } + }, + { + "in": "query", + "name": "state", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -7120,7 +7660,7 @@ }, "/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}": { "get": { - "description": "Gets a single execution result.", + "description": "Gets a single execution result. Note that the Arrow File and Arrow Stream content types are currently in BETA.", "operationId": "retrieveResult", "parameters": [ { @@ -7143,6 +7683,14 @@ "type": "string" } }, + { + "in": "header", + "name": "X-GDC-CANCEL-TOKEN", + "required": false, + "schema": { + "type": "string" + } + }, { "description": "Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM.", "example": "offset=1,10", @@ -7192,14 +7740,6 @@ "type": "array" }, "style": "form" - }, - { - "in": "header", - "name": "X-GDC-CANCEL-TOKEN", - "required": false, - "schema": { - "type": "string" - } } ], "responses": { @@ -7209,7 +7749,9 @@ "schema": { "$ref": "#/components/schemas/ExecutionResult" } - } + }, + "application/vnd.apache.arrow.file": {}, + "application/vnd.apache.arrow.stream": {} }, "description": "Execution result was found and returned." } @@ -8578,6 +9120,44 @@ ] } } + }, + "/api/v1/ailake/services/{serviceId}/status": { + "get": { + "description": "(BETA) Returns the status of a service in the organization's AI Lake. The status is controller-specific (e.g., available commands, readiness).", + "operationId": "getAiLakeServiceStatus", + "parameters": [ + { + "in": "path", + "name": "serviceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetServiceStatusResponse" + } + } + }, + "description": "AI Lake service status successfully retrieved" + } + }, + "summary": "(BETA) Get AI Lake service status", + "tags": [ + "AI Lake" + ], + "x-gdc-security-info": { + "description": "Permissions required to get AI Lake service status.", + "permissions": [ + "MANAGE" + ] + } + } } }, "servers": [ diff --git a/schemas/gooddata-api-client.json b/schemas/gooddata-api-client.json index d3c38d784..3005fdaa7 100644 --- a/schemas/gooddata-api-client.json +++ b/schemas/gooddata-api-client.json @@ -5754,6 +5754,7 @@ "GEO_LONGITUDE", "GEO_LATITUDE", "GEO_AREA", + "GEO_ICON", "IMAGE" ], "type": "string" @@ -6201,8 +6202,8 @@ "$ref": "#/components/schemas/AzureFoundryProviderAuth" }, "endpoint": { - "description": "Azure AI inference endpoint URL.", - "example": "https://my-resource.services.ai.azure.com/models", + "description": "Azure OpenAI endpoint URL.", + "example": "https://my-resource.openai.azure.com", "maxLength": 255, "type": "string" }, @@ -6842,6 +6843,7 @@ "GEO_LONGITUDE", "GEO_LATITUDE", "GEO_AREA", + "GEO_ICON", "IMAGE" ], "example": "HYPERLINK", @@ -7495,6 +7497,37 @@ ], "type": "object" }, + "DashboardContext": { + "description": "Dashboard the user is currently viewing.", + "properties": { + "id": { + "description": "Dashboard object ID.", + "type": "string" + }, + "widgets": { + "description": "Widgets currently visible on the dashboard.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/InsightWidgetDescriptor" + }, + { + "$ref": "#/components/schemas/RichTextWidgetDescriptor" + }, + { + "$ref": "#/components/schemas/VisualizationSwitcherWidgetDescriptor" + } + ] + }, + "type": "array" + } + }, + "required": [ + "id", + "widgets" + ], + "type": "object" + }, "DashboardDateFilter": { "properties": { "dateFilter": { @@ -7510,9 +7543,9 @@ }, "emptyValueHandling": { "enum": [ - "INCLUDE", - "EXCLUDE", - "ONLY" + "include", + "exclude", + "only" ], "type": "string" }, @@ -10088,6 +10121,7 @@ "GEO_LONGITUDE", "GEO_LATITUDE", "GEO_AREA", + "GEO_ICON", "IMAGE" ], "type": "string" @@ -10874,10 +10908,10 @@ "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", + "SORT_COLLATION", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -13333,6 +13367,18 @@ ], "type": "object" }, + "GetServiceStatusResponse": { + "description": "Status of an AI Lake service", + "properties": { + "status": { + "$ref": "#/components/schemas/JsonNode" + } + }, + "required": [ + "status" + ], + "type": "object" + }, "GrainIdentifier": { "description": "A grain identifier.", "example": { @@ -13705,6 +13751,41 @@ ], "type": "object" }, + "InsightWidgetDescriptor": { + "allOf": [ + { + "$ref": "#/components/schemas/WidgetDescriptor" + }, + { + "properties": { + "resultId": { + "description": "Signed result ID for this widget's cached execution result.", + "type": "string" + }, + "title": { + "description": "Widget title as displayed on the dashboard.", + "type": "string" + }, + "visualizationId": { + "description": "Visualization object ID referenced by this insight widget.", + "type": "string" + }, + "widgetId": { + "description": "Widget object ID.", + "type": "string" + } + }, + "type": "object" + } + ], + "description": "Insight widget displaying a visualization.", + "required": [ + "title", + "visualizationId", + "widgetId" + ], + "type": "object" + }, "IntroSlideTemplate": { "description": "Settings for intro slide.", "nullable": true, @@ -23059,6 +23140,7 @@ "GEO_LONGITUDE", "GEO_LATITUDE", "GEO_AREA", + "GEO_ICON", "IMAGE" ], "type": "string" @@ -23542,7 +23624,7 @@ "attributes": { "properties": { "defaultModelId": { - "description": "ID of the default model to use from the models list.", + "description": "Required ID of the default model to use from the models list.", "maxLength": 255, "nullable": true, "type": "string" @@ -23567,7 +23649,8 @@ "MISTRAL", "AMAZON", "GOOGLE", - "COHERE" + "COHERE", + "UNKNOWN" ], "type": "string" }, @@ -23593,6 +23676,7 @@ }, "providerConfig": { "description": "Provider-specific configuration including authentication.", + "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AwsBedrockProviderConfig" @@ -23606,10 +23690,6 @@ ] } }, - "required": [ - "models", - "providerConfig" - ], "type": "object" }, "id": { @@ -23628,7 +23708,6 @@ } }, "required": [ - "attributes", "id", "type" ], @@ -23651,7 +23730,7 @@ "attributes": { "properties": { "defaultModelId": { - "description": "ID of the default model to use from the models list.", + "description": "Required ID of the default model to use from the models list.", "maxLength": 255, "nullable": true, "type": "string" @@ -23676,7 +23755,8 @@ "MISTRAL", "AMAZON", "GOOGLE", - "COHERE" + "COHERE", + "UNKNOWN" ], "type": "string" }, @@ -23702,6 +23782,7 @@ }, "providerConfig": { "description": "Provider-specific configuration including authentication.", + "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AwsBedrockProviderConfig" @@ -23715,10 +23796,6 @@ ] } }, - "required": [ - "models", - "providerConfig" - ], "type": "object" }, "id": { @@ -23737,7 +23814,6 @@ } }, "required": [ - "attributes", "id", "type" ], @@ -23800,7 +23876,7 @@ "attributes": { "properties": { "defaultModelId": { - "description": "ID of the default model to use from the models list.", + "description": "Required ID of the default model to use from the models list.", "maxLength": 255, "nullable": true, "type": "string" @@ -23825,7 +23901,8 @@ "MISTRAL", "AMAZON", "GOOGLE", - "COHERE" + "COHERE", + "UNKNOWN" ], "type": "string" }, @@ -23851,6 +23928,7 @@ }, "providerConfig": { "description": "Provider-specific configuration including authentication.", + "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AwsBedrockProviderConfig" @@ -23882,7 +23960,6 @@ } }, "required": [ - "attributes", "id", "type" ], @@ -24720,7 +24797,7 @@ "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiMetricOutIncludes" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutIncludes" }, "type": "array", "uniqueItems": true @@ -24734,28 +24811,6 @@ ], "type": "object" }, - "JsonApiMetricOutIncludes": { - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiFactOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiLabelOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiMetricOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" - } - ] - }, "JsonApiMetricOutList": { "description": "A JSON:API document with a list of resources", "properties": { @@ -24769,7 +24824,7 @@ "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiMetricOutIncludes" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutIncludes" }, "type": "array", "uniqueItems": true @@ -26000,10 +26055,10 @@ "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", + "SORT_COLLATION", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -26099,10 +26154,10 @@ "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", + "SORT_COLLATION", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -26238,10 +26293,10 @@ "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", + "SORT_COLLATION", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -27743,10 +27798,10 @@ "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", + "SORT_COLLATION", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -27842,10 +27897,10 @@ "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", + "SORT_COLLATION", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -28265,7 +28320,7 @@ "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiMetricOutIncludes" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutIncludes" }, "type": "array", "uniqueItems": true @@ -28279,6 +28334,28 @@ ], "type": "object" }, + "JsonApiVisualizationObjectOutIncludes": { + "oneOf": [ + { + "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiFactOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiLabelOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiMetricOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" + } + ] + }, "JsonApiVisualizationObjectOutList": { "description": "A JSON:API document with a list of resources", "properties": { @@ -28292,7 +28369,7 @@ "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiMetricOutIncludes" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutIncludes" }, "type": "array", "uniqueItems": true @@ -30097,10 +30174,10 @@ "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", + "SORT_COLLATION", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -30196,10 +30273,10 @@ "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", + "SORT_COLLATION", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -30361,10 +30438,10 @@ "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", + "SORT_COLLATION", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -30460,10 +30537,10 @@ "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", + "SORT_COLLATION", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -30570,6 +30647,7 @@ "GEO_LONGITUDE", "GEO_LATITUDE", "GEO_AREA", + "GEO_ICON", "IMAGE" ], "type": "string" @@ -30821,6 +30899,52 @@ } ] }, + "ListLlmProviderModelsRequest": { + "properties": { + "providerConfig": { + "oneOf": [ + { + "$ref": "#/components/schemas/AwsBedrockProviderConfig" + }, + { + "$ref": "#/components/schemas/AzureFoundryProviderConfig" + }, + { + "$ref": "#/components/schemas/OpenAIProviderConfig" + } + ] + } + }, + "required": [ + "providerConfig" + ], + "type": "object" + }, + "ListLlmProviderModelsResponse": { + "properties": { + "message": { + "description": "Message about the listing result.", + "type": "string" + }, + "models": { + "description": "Available models on the provider.", + "items": { + "$ref": "#/components/schemas/LlmModel" + }, + "type": "array" + }, + "success": { + "description": "Whether the model listing succeeded.", + "type": "boolean" + } + }, + "required": [ + "message", + "models", + "success" + ], + "type": "object" + }, "ListServicesResponse": { "description": "Paged response for listing AI Lake services", "properties": { @@ -30854,7 +30978,8 @@ "MISTRAL", "AMAZON", "GOOGLE", - "COHERE" + "COHERE", + "UNKNOWN" ], "type": "string" }, @@ -30882,7 +31007,7 @@ "type": "object" }, "LlmProviderConfig": { - "description": "Provider configuration to test.", + "description": "Provider configuration overrides.", "oneOf": [ { "$ref": "#/components/schemas/AwsBedrockProviderConfig" @@ -31571,6 +31696,47 @@ }, "type": "object" }, + "ObjectReference": { + "properties": { + "id": { + "description": "Object identifier (e.g. widget ID, metric ID).", + "type": "string" + }, + "type": { + "description": "Type of the referenced object.", + "enum": [ + "WIDGET", + "METRIC", + "ATTRIBUTE", + "DASHBOARD" + ], + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "ObjectReferenceGroup": { + "properties": { + "context": { + "$ref": "#/components/schemas/ObjectReference" + }, + "objects": { + "description": "Objects the user explicitly referenced within this context.", + "items": { + "$ref": "#/components/schemas/ObjectReference" + }, + "type": "array" + } + }, + "required": [ + "objects" + ], + "type": "object" + }, "OpenAIProviderConfig": { "description": "Configuration for OpenAI provider.", "properties": { @@ -31578,10 +31744,9 @@ "$ref": "#/components/schemas/OpenAiProviderAuth" }, "baseUrl": { - "default": "https://api.openai.com", + "default": "https://api.openai.com/v1", "description": "Custom base URL for OpenAI API.", "maxLength": 255, - "nullable": true, "type": "string" }, "organization": { @@ -33143,10 +33308,10 @@ "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", + "SORT_COLLATION", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -33258,6 +33423,32 @@ ], "type": "object" }, + "RichTextWidgetDescriptor": { + "allOf": [ + { + "$ref": "#/components/schemas/WidgetDescriptor" + }, + { + "properties": { + "title": { + "description": "Widget title as displayed on the dashboard.", + "type": "string" + }, + "widgetId": { + "description": "Widget object ID.", + "type": "string" + } + }, + "type": "object" + } + ], + "description": "Rich text widget displaying static content. Has no execution result.", + "required": [ + "title", + "widgetId" + ], + "type": "object" + }, "RouteResult": { "description": "Question -> Use Case routing. May contain final answer is a special use case is not required.", "properties": { @@ -33885,6 +34076,16 @@ "example": true, "type": "boolean" }, + "grandTotalsPosition": { + "description": "Grand totals position. Takes precedence over position specified in visualization.", + "enum": [ + "pinnedBottom", + "pinnedTop", + "bottom", + "top" + ], + "type": "string" + }, "mergeHeaders": { "description": "Merge equal headers in neighbouring cells. (XLSX)", "example": true, @@ -34663,6 +34864,31 @@ ], "type": "object" }, + "TestLlmProviderByIdRequest": { + "properties": { + "models": { + "description": "Models overrides.", + "items": { + "$ref": "#/components/schemas/LlmModel" + }, + "type": "array" + }, + "providerConfig": { + "oneOf": [ + { + "$ref": "#/components/schemas/AwsBedrockProviderConfig" + }, + { + "$ref": "#/components/schemas/AzureFoundryProviderConfig" + }, + { + "$ref": "#/components/schemas/OpenAIProviderConfig" + } + ] + } + }, + "type": "object" + }, "TestLlmProviderDefinitionRequest": { "properties": { "models": { @@ -34933,6 +35159,112 @@ ], "type": "object" }, + "TrendingObjectItem": { + "description": "Trending analytics catalog objects", + "properties": { + "createdAt": { + "description": "Timestamp when object was created.", + "format": "date-time", + "type": "string" + }, + "createdBy": { + "description": "ID of the user who created the object.", + "type": "string" + }, + "datasetId": { + "description": "ID of the associated dataset, if applicable.", + "type": "string" + }, + "datasetTitle": { + "description": "Title of the associated dataset, if applicable.", + "type": "string" + }, + "datasetType": { + "description": "Type of the associated dataset, if applicable.", + "type": "string" + }, + "description": { + "description": "Object description.", + "type": "string" + }, + "id": { + "description": "Object ID.", + "type": "string" + }, + "isHidden": { + "description": "If true, this object is hidden from AI search results by default.", + "type": "boolean" + }, + "isHiddenFromKda": { + "description": "If true, this object is hidden from KDA.", + "type": "boolean" + }, + "metricType": { + "description": "Type of the metric (e.g. MAQL), if applicable.", + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when object was last modified.", + "format": "date-time", + "type": "string" + }, + "modifiedBy": { + "description": "ID of the user who last modified the object.", + "type": "string" + }, + "tags": { + "items": { + "description": "Tags assigned to the object.", + "type": "string" + }, + "type": "array" + }, + "title": { + "description": "Object title.", + "type": "string" + }, + "type": { + "description": "Object type, e.g. dashboard, visualization, metric.", + "type": "string" + }, + "usageCount": { + "description": "Number of times this object has been used/referenced.", + "format": "int32", + "type": "integer" + }, + "visualizationUrl": { + "description": "URL of the visualization, if applicable.", + "type": "string" + }, + "workspaceId": { + "description": "Workspace ID the object belongs to.", + "type": "string" + } + }, + "required": [ + "id", + "tags", + "title", + "type", + "usageCount", + "workspaceId" + ], + "type": "object" + }, + "TrendingObjectsResult": { + "properties": { + "objects": { + "items": { + "$ref": "#/components/schemas/TrendingObjectItem" + }, + "type": "array" + } + }, + "required": [ + "objects" + ], + "type": "object" + }, "TriggerAutomationRequest": { "properties": { "automation": { @@ -34968,6 +35300,15 @@ ], "type": "object" }, + "UIContext": { + "description": "Ambient UI state: what the user is currently looking at (dashboard, visible widgets).", + "properties": { + "dashboard": { + "$ref": "#/components/schemas/DashboardContext" + } + }, + "type": "object" + }, "Unit": { "type": "object" }, @@ -35049,14 +35390,24 @@ "type": "object" }, "UserContext": { - "description": "User context, which can affect the behavior of the underlying AI features.", + "description": "User context with ambient UI state (view) and explicitly referenced objects.", "properties": { "activeObject": { "$ref": "#/components/schemas/ActiveObjectIdentification" + }, + "referencedObjects": { + "description": "Groups of explicitly referenced objects, each optionally scoped by a context (e.g. a dashboard context with widget references).", + "items": { + "$ref": "#/components/schemas/ObjectReferenceGroup" + }, + "type": "array" + }, + "view": { + "$ref": "#/components/schemas/UIContext" } }, "required": [ - "activeObject" + "referencedObjects" ], "type": "object" }, @@ -35574,6 +35925,49 @@ }, "type": "object" }, + "VisualizationSwitcherWidgetDescriptor": { + "allOf": [ + { + "$ref": "#/components/schemas/WidgetDescriptor" + }, + { + "properties": { + "activeVisualizationId": { + "description": "ID of the currently active visualization in the switcher.", + "type": "string" + }, + "resultId": { + "description": "Signed result ID for the currently active visualization's execution result.", + "type": "string" + }, + "title": { + "description": "Widget title as displayed on the dashboard.", + "type": "string" + }, + "visualizationIds": { + "description": "IDs of all visualizations available in the switcher.", + "items": { + "type": "string" + }, + "type": "array" + }, + "widgetId": { + "description": "Widget object ID.", + "type": "string" + } + }, + "type": "object" + } + ], + "description": "Visualization switcher widget allowing users to toggle between multiple visualizations.", + "required": [ + "activeVisualizationId", + "title", + "visualizationIds", + "widgetId" + ], + "type": "object" + }, "Webhook": { "allOf": [ { @@ -35882,6 +36276,34 @@ ], "type": "object" }, + "WidgetDescriptor": { + "description": "Descriptor for a widget on the dashboard.", + "discriminator": { + "mapping": { + "insight": "#/components/schemas/InsightWidgetDescriptor", + "richText": "#/components/schemas/RichTextWidgetDescriptor", + "visualizationSwitcher": "#/components/schemas/VisualizationSwitcherWidgetDescriptor" + }, + "propertyName": "widgetType" + }, + "properties": { + "title": { + "type": "string" + }, + "widgetId": { + "type": "string" + }, + "widgetType": { + "type": "string" + } + }, + "required": [ + "title", + "widgetId", + "widgetType" + ], + "type": "object" + }, "WidgetSlidesTemplate": { "description": "Template for widget slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", "nullable": true, @@ -36406,6 +36828,39 @@ ] } }, + "/api/v1/actions/ai/llmProvider/listModels": { + "post": { + "description": "Lists models available on an LLM provider with a full definition. For Azure AI Foundry providers, the model family will be set to UNKNOWN because the endpoint does not expose the family.", + "operationId": "listLlmProviderModels", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListLlmProviderModelsRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListLlmProviderModelsResponse" + } + } + }, + "description": "OK" + } + }, + "summary": "List LLM Provider Models", + "tags": [ + "Smart Functions", + "actions" + ] + } + }, "/api/v1/actions/ai/llmProvider/test": { "post": { "description": "Tests LLM provider connectivity with a full definition.", @@ -36439,6 +36894,39 @@ ] } }, + "/api/v1/actions/ai/llmProvider/{llmProviderId}/listModels": { + "post": { + "description": "Lists models available on an existing LLM provider by its ID. For Azure AI Foundry providers, the model family will be set to UNKNOWN because the endpoint does not expose the family.", + "operationId": "listLlmProviderModelsById", + "parameters": [ + { + "in": "path", + "name": "llmProviderId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListLlmProviderModelsResponse" + } + } + }, + "description": "OK" + } + }, + "summary": "List LLM Provider Models By Id", + "tags": [ + "Smart Functions", + "actions" + ] + } + }, "/api/v1/actions/ai/llmProvider/{llmProviderId}/test": { "post": { "description": "Tests an existing LLM provider connectivity by its ID.", @@ -36453,6 +36941,15 @@ } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TestLlmProviderByIdRequest" + } + } + } + }, "responses": { "200": { "content": { @@ -38344,6 +38841,41 @@ ] } }, + "/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/trendingObjects": { + "get": { + "description": "Returns a list of trending objects for this workspace", + "operationId": "trendingObjects", + "parameters": [ + { + "description": "Workspace identifier", + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TrendingObjectsResult" + } + } + }, + "description": "OK" + } + }, + "summary": "Get Trending Analytics Catalog Objects", + "tags": [ + "Smart Functions", + "actions" + ] + } + }, "/api/v1/actions/workspaces/{workspaceId}/ai/chat": { "post": { "description": "(BETA) Combines multiple use cases such as search, create visualizations, ...", @@ -38680,6 +39212,22 @@ "schema": { "type": "string" } + }, + { + "in": "query", + "name": "state", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -39927,7 +40475,7 @@ }, "/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}": { "get": { - "description": "Gets a single execution result.", + "description": "Gets a single execution result. Note that the Arrow File and Arrow Stream content types are currently in BETA.", "operationId": "retrieveResult", "parameters": [ { @@ -39950,6 +40498,14 @@ "type": "string" } }, + { + "in": "header", + "name": "X-GDC-CANCEL-TOKEN", + "required": false, + "schema": { + "type": "string" + } + }, { "description": "Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM.", "example": "offset=1,10", @@ -39999,14 +40555,6 @@ "type": "array" }, "style": "form" - }, - { - "in": "header", - "name": "X-GDC-CANCEL-TOKEN", - "required": false, - "schema": { - "type": "string" - } } ], "responses": { @@ -40016,7 +40564,9 @@ "schema": { "$ref": "#/components/schemas/ExecutionResult" } - } + }, + "application/vnd.apache.arrow.file": {}, + "application/vnd.apache.arrow.stream": {} }, "description": "Execution result was found and returned." } @@ -42982,6 +43532,44 @@ } } }, + "/api/v1/ailake/services/{serviceId}/status": { + "get": { + "description": "(BETA) Returns the status of a service in the organization's AI Lake. The status is controller-specific (e.g., available commands, readiness).", + "operationId": "getAiLakeServiceStatus", + "parameters": [ + { + "in": "path", + "name": "serviceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetServiceStatusResponse" + } + } + }, + "description": "AI Lake service status successfully retrieved" + } + }, + "summary": "(BETA) Get AI Lake service status", + "tags": [ + "AI Lake" + ], + "x-gdc-security-info": { + "description": "Permissions required to get AI Lake service status.", + "permissions": [ + "MANAGE" + ] + } + } + }, "/api/v1/entities/admin/cookieSecurityConfigurations/{id}": { "get": { "operationId": "getEntity@CookieSecurityConfigurations", @@ -43020,7 +43608,7 @@ "tags": [ "Cookie Security Configuration", "entities", - "organization-controller" + "cookie-security-configuration-controller" ] }, "patch": { @@ -43075,7 +43663,7 @@ "tags": [ "Cookie Security Configuration", "entities", - "organization-controller" + "cookie-security-configuration-controller" ] }, "put": { @@ -43130,7 +43718,7 @@ "tags": [ "Cookie Security Configuration", "entities", - "organization-controller" + "cookie-security-configuration-controller" ] } }, @@ -43218,7 +43806,7 @@ "tags": [ "Organization - Entity APIs", "entities", - "organization-controller" + "organization-entity-controller" ], "x-gdc-security-info": { "description": "Contains permissions required to manipulate the Organization.", @@ -43303,7 +43891,7 @@ "tags": [ "Organization - Entity APIs", "entities", - "organization-controller" + "organization-entity-controller" ], "x-gdc-security-info": { "description": "Contains permissions required to manipulate the Organization.", @@ -43388,7 +43976,7 @@ "tags": [ "Organization - Entity APIs", "entities", - "organization-controller" + "organization-entity-controller" ], "x-gdc-security-info": { "description": "Contains permissions required to manipulate the Organization.", @@ -44072,10 +44660,11 @@ "description": "Request successfully processed" } }, + "summary": "Get all Custom Geo Collections", "tags": [ "Geographic Data", "entities", - "organization-model-controller" + "custom-geo-collection-controller" ] }, "post": { @@ -44112,10 +44701,11 @@ "description": "Request successfully processed" } }, + "summary": "Post Custom Geo Collections", "tags": [ "Geographic Data", "entities", - "organization-model-controller" + "custom-geo-collection-controller" ] } }, @@ -44141,10 +44731,11 @@ "$ref": "#/components/responses/Deleted" } }, + "summary": "Delete Custom Geo Collection", "tags": [ "Geographic Data", "entities", - "organization-model-controller" + "custom-geo-collection-controller" ] }, "get": { @@ -44180,10 +44771,11 @@ "description": "Request successfully processed" } }, + "summary": "Get Custom Geo Collection", "tags": [ "Geographic Data", "entities", - "organization-model-controller" + "custom-geo-collection-controller" ] }, "patch": { @@ -44234,10 +44826,11 @@ "description": "Request successfully processed" } }, + "summary": "Patch Custom Geo Collection", "tags": [ "Geographic Data", "entities", - "organization-model-controller" + "custom-geo-collection-controller" ] }, "put": { @@ -44288,10 +44881,11 @@ "description": "Request successfully processed" } }, + "summary": "Put Custom Geo Collection", "tags": [ "Geographic Data", "entities", - "organization-model-controller" + "custom-geo-collection-controller" ] } }, @@ -44510,7 +45104,7 @@ "tags": [ "Data Source - Entity APIs", "entities", - "organization-model-controller" + "data-source-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -44582,7 +45176,7 @@ "tags": [ "Data Source - Entity APIs", "entities", - "organization-model-controller" + "data-source-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -44619,7 +45213,7 @@ "tags": [ "Data Source - Entity APIs", "entities", - "organization-model-controller" + "data-source-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -44688,7 +45282,7 @@ "tags": [ "Data Source - Entity APIs", "entities", - "organization-model-controller" + "data-source-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -44750,7 +45344,7 @@ "tags": [ "Data Source - Entity APIs", "entities", - "organization-model-controller" + "data-source-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -44812,7 +45406,7 @@ "tags": [ "Data Source - Entity APIs", "entities", - "organization-model-controller" + "data-source-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -45609,7 +46203,7 @@ "tags": [ "JWKS", "entities", - "organization-model-controller" + "jwk-controller" ] }, "post": { @@ -45651,7 +46245,7 @@ "tags": [ "JWKS", "entities", - "organization-model-controller" + "jwk-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -45688,7 +46282,7 @@ "tags": [ "JWKS", "entities", - "organization-model-controller" + "jwk-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -45735,7 +46329,7 @@ "tags": [ "JWKS", "entities", - "organization-model-controller" + "jwk-controller" ] }, "patch": { @@ -45791,7 +46385,7 @@ "tags": [ "JWKS", "entities", - "organization-model-controller" + "jwk-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -45853,7 +46447,7 @@ "tags": [ "JWKS", "entities", - "organization-model-controller" + "jwk-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -48697,7 +49291,7 @@ "tags": [ "API tokens", "entities", - "user-model-controller" + "api-token-controller" ] }, "post": { @@ -48748,7 +49342,7 @@ "tags": [ "API tokens", "entities", - "user-model-controller" + "api-token-controller" ] } }, @@ -48786,7 +49380,7 @@ "tags": [ "API tokens", "entities", - "user-model-controller" + "api-token-controller" ] }, "get": { @@ -48834,7 +49428,7 @@ "tags": [ "API tokens", "entities", - "user-model-controller" + "api-token-controller" ] } }, @@ -48912,7 +49506,7 @@ "tags": [ "User Settings", "entities", - "user-model-controller" + "user-setting-controller" ] }, "post": { @@ -48963,7 +49557,7 @@ "tags": [ "User Settings", "entities", - "user-model-controller" + "user-setting-controller" ] } }, @@ -49001,7 +49595,7 @@ "tags": [ "User Settings", "entities", - "user-model-controller" + "user-setting-controller" ] }, "get": { @@ -49049,7 +49643,7 @@ "tags": [ "User Settings", "entities", - "user-model-controller" + "user-setting-controller" ] }, "put": { @@ -49112,7 +49706,7 @@ "tags": [ "User Settings", "entities", - "user-model-controller" + "user-setting-controller" ] } }, @@ -50039,7 +50633,7 @@ "tags": [ "Dashboards", "entities", - "workspace-object-controller" + "analytical-dashboard-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -50149,7 +50743,7 @@ "tags": [ "Dashboards", "entities", - "workspace-object-controller" + "analytical-dashboard-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -50224,11 +50818,11 @@ "description": "Request successfully processed" } }, - "summary": "Search request for AnalyticalDashboard", + "summary": "The search endpoint (beta)", "tags": [ "Dashboards", "entities", - "workspace-object-controller" + "analytical-dashboard-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -50277,7 +50871,7 @@ "tags": [ "Dashboards", "entities", - "workspace-object-controller" + "analytical-dashboard-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -50398,7 +50992,7 @@ "tags": [ "Dashboards", "entities", - "workspace-object-controller" + "analytical-dashboard-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -50501,7 +51095,7 @@ "tags": [ "Dashboards", "entities", - "workspace-object-controller" + "analytical-dashboard-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -50604,7 +51198,7 @@ "tags": [ "Dashboards", "entities", - "workspace-object-controller" + "analytical-dashboard-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -50735,7 +51329,7 @@ "tags": [ "Attribute Hierarchies", "entities", - "workspace-object-controller" + "attribute-hierarchy-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -50836,7 +51430,7 @@ "tags": [ "Attribute Hierarchies", "entities", - "workspace-object-controller" + "attribute-hierarchy-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -50911,11 +51505,11 @@ "description": "Request successfully processed" } }, - "summary": "Search request for AttributeHierarchy", + "summary": "The search endpoint (beta)", "tags": [ "Attribute Hierarchies", "entities", - "workspace-object-controller" + "attribute-hierarchy-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -50964,7 +51558,7 @@ "tags": [ "Attribute Hierarchies", "entities", - "workspace-object-controller" + "attribute-hierarchy-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -51076,7 +51670,7 @@ "tags": [ "Attribute Hierarchies", "entities", - "workspace-object-controller" + "attribute-hierarchy-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -51172,7 +51766,7 @@ "tags": [ "Attribute Hierarchies", "entities", - "workspace-object-controller" + "attribute-hierarchy-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -51268,7 +51862,7 @@ "tags": [ "Attribute Hierarchies", "entities", - "workspace-object-controller" + "attribute-hierarchy-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -51400,8 +51994,14 @@ "tags": [ "Attributes", "entities", - "workspace-object-controller" - ] + "attribute-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } } }, "/api/v1/entities/workspaces/{workspaceId}/attributes/search": { @@ -51469,12 +52069,18 @@ "description": "Request successfully processed" } }, - "summary": "Search request for Attribute", + "summary": "The search endpoint (beta)", "tags": [ "Attributes", "entities", - "workspace-object-controller" - ] + "attribute-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } } }, "/api/v1/entities/workspaces/{workspaceId}/attributes/{objectId}": { @@ -51582,8 +52188,14 @@ "tags": [ "Attributes", "entities", - "workspace-object-controller" - ] + "attribute-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } }, "patch": { "operationId": "patchEntity@Attributes", @@ -51673,8 +52285,14 @@ "tags": [ "Attributes", "entities", - "workspace-object-controller" - ] + "attribute-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } } }, "/api/v1/entities/workspaces/{workspaceId}/automationResults/search": { @@ -51878,7 +52496,7 @@ "tags": [ "Automations", "entities", - "workspace-object-controller" + "automation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -51986,7 +52604,7 @@ "tags": [ "Automations", "entities", - "workspace-object-controller" + "automation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -52061,11 +52679,11 @@ "description": "Request successfully processed" } }, - "summary": "Search request for Automation", + "summary": "The search endpoint (beta)", "tags": [ "Automations", "entities", - "workspace-object-controller" + "automation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -52114,7 +52732,7 @@ "tags": [ "Automations", "entities", - "workspace-object-controller" + "automation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -52233,7 +52851,7 @@ "tags": [ "Automations", "entities", - "workspace-object-controller" + "automation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -52336,7 +52954,7 @@ "tags": [ "Automations", "entities", - "workspace-object-controller" + "automation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -52439,7 +53057,7 @@ "tags": [ "Automations", "entities", - "workspace-object-controller" + "automation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -52548,7 +53166,7 @@ "tags": [ "Workspaces - Settings", "entities", - "workspace-object-controller" + "custom-application-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -52627,7 +53245,7 @@ "tags": [ "Workspaces - Settings", "entities", - "workspace-object-controller" + "custom-application-setting-controller" ] } }, @@ -52696,11 +53314,11 @@ "description": "Request successfully processed" } }, - "summary": "Search request for CustomApplicationSetting", + "summary": "The search endpoint (beta)", "tags": [ "Workspaces - Settings", "entities", - "workspace-object-controller" + "custom-application-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -52749,7 +53367,7 @@ "tags": [ "Workspaces - Settings", "entities", - "workspace-object-controller" + "custom-application-setting-controller" ] }, "get": { @@ -52833,7 +53451,7 @@ "tags": [ "Workspaces - Settings", "entities", - "workspace-object-controller" + "custom-application-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -52907,7 +53525,7 @@ "tags": [ "Workspaces - Settings", "entities", - "workspace-object-controller" + "custom-application-setting-controller" ] }, "put": { @@ -52975,7 +53593,7 @@ "tags": [ "Workspaces - Settings", "entities", - "workspace-object-controller" + "custom-application-setting-controller" ] } }, @@ -53099,7 +53717,7 @@ "tags": [ "Plugins", "entities", - "workspace-object-controller" + "dashboard-plugin-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -53199,7 +53817,7 @@ "tags": [ "Plugins", "entities", - "workspace-object-controller" + "dashboard-plugin-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -53274,11 +53892,11 @@ "description": "Request successfully processed" } }, - "summary": "Search request for DashboardPlugin", + "summary": "The search endpoint (beta)", "tags": [ "Plugins", "entities", - "workspace-object-controller" + "dashboard-plugin-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -53327,7 +53945,7 @@ "tags": [ "Plugins", "entities", - "workspace-object-controller" + "dashboard-plugin-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -53438,7 +54056,7 @@ "tags": [ "Plugins", "entities", - "workspace-object-controller" + "dashboard-plugin-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -53533,7 +54151,7 @@ "tags": [ "Plugins", "entities", - "workspace-object-controller" + "dashboard-plugin-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -53628,7 +54246,7 @@ "tags": [ "Plugins", "entities", - "workspace-object-controller" + "dashboard-plugin-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -53761,8 +54379,14 @@ "tags": [ "Datasets", "entities", - "workspace-object-controller" - ] + "dataset-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } } }, "/api/v1/entities/workspaces/{workspaceId}/datasets/search": { @@ -53830,12 +54454,18 @@ "description": "Request successfully processed" } }, - "summary": "Search request for Dataset", + "summary": "The search endpoint (beta)", "tags": [ "Datasets", "entities", - "workspace-object-controller" - ] + "dataset-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } } }, "/api/v1/entities/workspaces/{workspaceId}/datasets/{objectId}": { @@ -53944,8 +54574,14 @@ "tags": [ "Datasets", "entities", - "workspace-object-controller" - ] + "dataset-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } }, "patch": { "operationId": "patchEntity@Datasets", @@ -54036,8 +54672,14 @@ "tags": [ "Datasets", "entities", - "workspace-object-controller" - ] + "dataset-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } } }, "/api/v1/entities/workspaces/{workspaceId}/exportDefinitions": { @@ -54166,7 +54808,7 @@ "tags": [ "Export Definitions", "entities", - "workspace-object-controller" + "export-definition-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -54272,7 +54914,7 @@ "tags": [ "Export Definitions", "entities", - "workspace-object-controller" + "export-definition-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -54347,11 +54989,11 @@ "description": "Request successfully processed" } }, - "summary": "Search request for ExportDefinition", + "summary": "The search endpoint (beta)", "tags": [ "Export Definitions", "entities", - "workspace-object-controller" + "export-definition-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -54400,7 +55042,7 @@ "tags": [ "Export Definitions", "entities", - "workspace-object-controller" + "export-definition-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -54517,7 +55159,7 @@ "tags": [ "Export Definitions", "entities", - "workspace-object-controller" + "export-definition-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -54618,7 +55260,7 @@ "tags": [ "Export Definitions", "entities", - "workspace-object-controller" + "export-definition-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -54719,7 +55361,7 @@ "tags": [ "Export Definitions", "entities", - "workspace-object-controller" + "export-definition-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -54848,7 +55490,7 @@ "tags": [ "Facts", "entities", - "workspace-object-controller" + "fact-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -54923,11 +55565,11 @@ "description": "Request successfully processed" } }, - "summary": "Search request for Fact", + "summary": "The search endpoint (beta)", "tags": [ "Facts", "entities", - "workspace-object-controller" + "fact-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -55039,7 +55681,7 @@ "tags": [ "Facts", "entities", - "workspace-object-controller" + "fact-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -55133,7 +55775,7 @@ "tags": [ "Facts", "entities", - "workspace-object-controller" + "fact-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -55263,7 +55905,7 @@ "tags": [ "Filter Context", "entities", - "workspace-object-controller" + "filter-context-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -55363,7 +56005,7 @@ "tags": [ "Filter Context", "entities", - "workspace-object-controller" + "filter-context-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -55438,11 +56080,11 @@ "description": "Request successfully processed" } }, - "summary": "Search request for FilterContext", + "summary": "The search endpoint (beta)", "tags": [ "Filter Context", "entities", - "workspace-object-controller" + "filter-context-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -55491,7 +56133,7 @@ "tags": [ "Filter Context", "entities", - "workspace-object-controller" + "filter-context-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -55602,7 +56244,7 @@ "tags": [ "Filter Context", "entities", - "workspace-object-controller" + "filter-context-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -55697,7 +56339,7 @@ "tags": [ "Filter Context", "entities", - "workspace-object-controller" + "filter-context-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -55792,7 +56434,7 @@ "tags": [ "Filter Context", "entities", - "workspace-object-controller" + "filter-context-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -55922,7 +56564,7 @@ "tags": [ "Filter Views", "entities", - "workspace-object-controller" + "filter-view-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -56001,7 +56643,7 @@ "tags": [ "Filter Views", "entities", - "workspace-object-controller" + "filter-view-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage Filter Views", @@ -56076,11 +56718,11 @@ "description": "Request successfully processed" } }, - "summary": "Search request for FilterView", + "summary": "The search endpoint (beta)", "tags": [ "Filter Views", "entities", - "workspace-object-controller" + "filter-view-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -56129,7 +56771,7 @@ "tags": [ "Filter Views", "entities", - "workspace-object-controller" + "filter-view-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage Filter Views", @@ -56219,7 +56861,7 @@ "tags": [ "Filter Views", "entities", - "workspace-object-controller" + "filter-view-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -56315,7 +56957,7 @@ "tags": [ "Filter Views", "entities", - "workspace-object-controller" + "filter-view-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage Filter Views", @@ -56411,7 +57053,7 @@ "tags": [ "Filter Views", "entities", - "workspace-object-controller" + "filter-view-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage Filter Views", @@ -56704,6 +57346,7 @@ "description": "Request successfully processed" } }, + "summary": "The search endpoint (beta)", "tags": [ "AI", "entities", @@ -57155,7 +57798,7 @@ "tags": [ "Labels", "entities", - "workspace-object-controller" + "label-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -57230,11 +57873,11 @@ "description": "Request successfully processed" } }, - "summary": "Search request for Label", + "summary": "The search endpoint (beta)", "tags": [ "Labels", "entities", - "workspace-object-controller" + "label-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -57346,7 +57989,7 @@ "tags": [ "Labels", "entities", - "workspace-object-controller" + "label-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -57440,7 +58083,7 @@ "tags": [ "Labels", "entities", - "workspace-object-controller" + "label-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -58187,7 +58830,7 @@ "tags": [ "Metrics", "entities", - "workspace-object-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -58293,7 +58936,7 @@ "tags": [ "Metrics", "entities", - "workspace-object-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -58368,11 +59011,11 @@ "description": "Request successfully processed" } }, - "summary": "Search request for Metric", + "summary": "The search endpoint (beta)", "tags": [ "Metrics", "entities", - "workspace-object-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -58421,7 +59064,7 @@ "tags": [ "Metrics", "entities", - "workspace-object-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -58538,7 +59181,7 @@ "tags": [ "Metrics", "entities", - "workspace-object-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -58639,7 +59282,7 @@ "tags": [ "Metrics", "entities", - "workspace-object-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -58740,7 +59383,7 @@ "tags": [ "Metrics", "entities", - "workspace-object-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -58876,8 +59519,14 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" - ] + "user-data-filter-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } }, "post": { "operationId": "createEntity@UserDataFilters", @@ -58976,8 +59625,14 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" - ] + "user-data-filter-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } } }, "/api/v1/entities/workspaces/{workspaceId}/userDataFilters/search": { @@ -59045,12 +59700,18 @@ "description": "Request successfully processed" } }, - "summary": "Search request for UserDataFilter", + "summary": "The search endpoint (beta)", "tags": [ "Data Filters", "entities", - "workspace-object-controller" - ] + "user-data-filter-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } } }, "/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}": { @@ -59092,8 +59753,14 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" - ] + "user-data-filter-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } }, "get": { "operationId": "getEntity@UserDataFilters", @@ -59203,8 +59870,14 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" - ] + "user-data-filter-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } }, "patch": { "operationId": "patchEntity@UserDataFilters", @@ -59298,8 +59971,14 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" - ] + "user-data-filter-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } }, "put": { "operationId": "updateEntity@UserDataFilters", @@ -59393,8 +60072,14 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" - ] + "user-data-filter-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } } }, "/api/v1/entities/workspaces/{workspaceId}/visualizationObjects": { @@ -59523,7 +60208,7 @@ "tags": [ "Visualization Object", "entities", - "workspace-object-controller" + "visualization-object-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -59629,7 +60314,7 @@ "tags": [ "Visualization Object", "entities", - "workspace-object-controller" + "visualization-object-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -59704,11 +60389,11 @@ "description": "Request successfully processed" } }, - "summary": "Search request for VisualizationObject", + "summary": "The search endpoint (beta)", "tags": [ "Visualization Object", "entities", - "workspace-object-controller" + "visualization-object-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -59757,7 +60442,7 @@ "tags": [ "Visualization Object", "entities", - "workspace-object-controller" + "visualization-object-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -59874,7 +60559,7 @@ "tags": [ "Visualization Object", "entities", - "workspace-object-controller" + "visualization-object-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -59975,7 +60660,7 @@ "tags": [ "Visualization Object", "entities", - "workspace-object-controller" + "visualization-object-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -60076,7 +60761,7 @@ "tags": [ "Visualization Object", "entities", - "workspace-object-controller" + "visualization-object-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -60205,7 +60890,7 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" + "workspace-data-filter-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -60304,7 +60989,7 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" + "workspace-data-filter-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", @@ -60379,11 +61064,11 @@ "description": "Request successfully processed" } }, - "summary": "Search request for WorkspaceDataFilterSetting", + "summary": "The search endpoint (beta)", "tags": [ "Data Filters", "entities", - "workspace-object-controller" + "workspace-data-filter-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -60432,7 +61117,7 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" + "workspace-data-filter-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", @@ -60542,7 +61227,7 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" + "workspace-data-filter-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -60636,7 +61321,7 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" + "workspace-data-filter-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", @@ -60730,7 +61415,7 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" + "workspace-data-filter-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", @@ -60859,7 +61544,7 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" + "workspace-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -60958,7 +61643,7 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" + "workspace-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", @@ -61033,11 +61718,11 @@ "description": "Request successfully processed" } }, - "summary": "Search request for WorkspaceDataFilter", + "summary": "The search endpoint (beta)", "tags": [ "Data Filters", "entities", - "workspace-object-controller" + "workspace-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -61086,7 +61771,7 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" + "workspace-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", @@ -61196,7 +61881,7 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" + "workspace-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -61290,7 +61975,7 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" + "workspace-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", @@ -61384,7 +62069,7 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" + "workspace-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", @@ -61493,7 +62178,7 @@ "tags": [ "Workspaces - Settings", "entities", - "workspace-object-controller" + "workspace-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -61572,7 +62257,7 @@ "tags": [ "Workspaces - Settings", "entities", - "workspace-object-controller" + "workspace-setting-controller" ] } }, @@ -61641,10 +62326,11 @@ "description": "Request successfully processed" } }, + "summary": "The search endpoint (beta)", "tags": [ "Workspaces - Settings", "entities", - "workspace-object-controller" + "workspace-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -61693,7 +62379,7 @@ "tags": [ "Workspaces - Settings", "entities", - "workspace-object-controller" + "workspace-setting-controller" ] }, "get": { @@ -61777,7 +62463,7 @@ "tags": [ "Workspaces - Settings", "entities", - "workspace-object-controller" + "workspace-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -61851,7 +62537,7 @@ "tags": [ "Workspaces - Settings", "entities", - "workspace-object-controller" + "workspace-setting-controller" ] }, "put": { @@ -61919,7 +62605,7 @@ "tags": [ "Workspaces - Settings", "entities", - "workspace-object-controller" + "workspace-setting-controller" ] } }, diff --git a/schemas/gooddata-automation-client.json b/schemas/gooddata-automation-client.json index cb4e6ec33..b64cf3e64 100644 --- a/schemas/gooddata-automation-client.json +++ b/schemas/gooddata-automation-client.json @@ -1383,9 +1383,9 @@ }, "emptyValueHandling": { "enum": [ - "INCLUDE", - "EXCLUDE", - "ONLY" + "include", + "exclude", + "only" ], "type": "string" }, @@ -2989,6 +2989,16 @@ "example": true, "type": "boolean" }, + "grandTotalsPosition": { + "description": "Grand totals position. Takes precedence over position specified in visualization.", + "enum": [ + "pinnedBottom", + "pinnedTop", + "bottom", + "top" + ], + "type": "string" + }, "mergeHeaders": { "description": "Merge equal headers in neighbouring cells. (XLSX)", "example": true, diff --git a/schemas/gooddata-export-client.json b/schemas/gooddata-export-client.json index 59f86d5ed..9f28d7ec7 100644 --- a/schemas/gooddata-export-client.json +++ b/schemas/gooddata-export-client.json @@ -836,9 +836,9 @@ }, "emptyValueHandling": { "enum": [ - "INCLUDE", - "EXCLUDE", - "ONLY" + "include", + "exclude", + "only" ], "type": "string" }, @@ -2009,6 +2009,16 @@ "example": true, "type": "boolean" }, + "grandTotalsPosition": { + "description": "Grand totals position. Takes precedence over position specified in visualization.", + "enum": [ + "pinnedBottom", + "pinnedTop", + "bottom", + "top" + ], + "type": "string" + }, "mergeHeaders": { "description": "Merge equal headers in neighbouring cells. (XLSX)", "example": true, diff --git a/schemas/gooddata-metadata-client.json b/schemas/gooddata-metadata-client.json index baaa8cc58..b66ae4ed8 100644 --- a/schemas/gooddata-metadata-client.json +++ b/schemas/gooddata-metadata-client.json @@ -5479,8 +5479,8 @@ "$ref": "#/components/schemas/AzureFoundryProviderAuth" }, "endpoint": { - "description": "Azure AI inference endpoint URL.", - "example": "https://my-resource.services.ai.azure.com/models", + "description": "Azure OpenAI endpoint URL.", + "example": "https://my-resource.openai.azure.com", "maxLength": 255, "type": "string" }, @@ -5574,6 +5574,7 @@ "GEO_LONGITUDE", "GEO_LATITUDE", "GEO_AREA", + "GEO_ICON", "IMAGE" ], "example": "HYPERLINK", @@ -5938,9 +5939,9 @@ }, "emptyValueHandling": { "enum": [ - "INCLUDE", - "EXCLUDE", - "ONLY" + "include", + "exclude", + "only" ], "type": "string" }, @@ -8275,6 +8276,7 @@ "GEO_LONGITUDE", "GEO_LATITUDE", "GEO_AREA", + "GEO_ICON", "IMAGE" ], "type": "string" @@ -9061,10 +9063,10 @@ "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", + "SORT_COLLATION", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -20238,6 +20240,7 @@ "GEO_LONGITUDE", "GEO_LATITUDE", "GEO_AREA", + "GEO_ICON", "IMAGE" ], "type": "string" @@ -20721,7 +20724,7 @@ "attributes": { "properties": { "defaultModelId": { - "description": "ID of the default model to use from the models list.", + "description": "Required ID of the default model to use from the models list.", "maxLength": 255, "nullable": true, "type": "string" @@ -20746,7 +20749,8 @@ "MISTRAL", "AMAZON", "GOOGLE", - "COHERE" + "COHERE", + "UNKNOWN" ], "type": "string" }, @@ -20772,6 +20776,7 @@ }, "providerConfig": { "description": "Provider-specific configuration including authentication.", + "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AwsBedrockProviderConfig" @@ -20785,10 +20790,6 @@ ] } }, - "required": [ - "models", - "providerConfig" - ], "type": "object" }, "id": { @@ -20807,7 +20808,6 @@ } }, "required": [ - "attributes", "id", "type" ], @@ -20830,7 +20830,7 @@ "attributes": { "properties": { "defaultModelId": { - "description": "ID of the default model to use from the models list.", + "description": "Required ID of the default model to use from the models list.", "maxLength": 255, "nullable": true, "type": "string" @@ -20855,7 +20855,8 @@ "MISTRAL", "AMAZON", "GOOGLE", - "COHERE" + "COHERE", + "UNKNOWN" ], "type": "string" }, @@ -20881,6 +20882,7 @@ }, "providerConfig": { "description": "Provider-specific configuration including authentication.", + "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AwsBedrockProviderConfig" @@ -20894,10 +20896,6 @@ ] } }, - "required": [ - "models", - "providerConfig" - ], "type": "object" }, "id": { @@ -20916,7 +20914,6 @@ } }, "required": [ - "attributes", "id", "type" ], @@ -20979,7 +20976,7 @@ "attributes": { "properties": { "defaultModelId": { - "description": "ID of the default model to use from the models list.", + "description": "Required ID of the default model to use from the models list.", "maxLength": 255, "nullable": true, "type": "string" @@ -21004,7 +21001,8 @@ "MISTRAL", "AMAZON", "GOOGLE", - "COHERE" + "COHERE", + "UNKNOWN" ], "type": "string" }, @@ -21030,6 +21028,7 @@ }, "providerConfig": { "description": "Provider-specific configuration including authentication.", + "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AwsBedrockProviderConfig" @@ -21061,7 +21060,6 @@ } }, "required": [ - "attributes", "id", "type" ], @@ -21899,7 +21897,7 @@ "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiMetricOutIncludes" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutIncludes" }, "type": "array", "uniqueItems": true @@ -21913,28 +21911,6 @@ ], "type": "object" }, - "JsonApiMetricOutIncludes": { - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiFactOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiLabelOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiMetricOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" - } - ] - }, "JsonApiMetricOutList": { "description": "A JSON:API document with a list of resources", "properties": { @@ -21948,7 +21924,7 @@ "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiMetricOutIncludes" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutIncludes" }, "type": "array", "uniqueItems": true @@ -23179,10 +23155,10 @@ "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", + "SORT_COLLATION", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -23278,10 +23254,10 @@ "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", + "SORT_COLLATION", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -23417,10 +23393,10 @@ "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", + "SORT_COLLATION", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -24922,10 +24898,10 @@ "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", + "SORT_COLLATION", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -25021,10 +24997,10 @@ "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", + "SORT_COLLATION", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -25444,7 +25420,7 @@ "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiMetricOutIncludes" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutIncludes" }, "type": "array", "uniqueItems": true @@ -25458,6 +25434,28 @@ ], "type": "object" }, + "JsonApiVisualizationObjectOutIncludes": { + "oneOf": [ + { + "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiFactOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiLabelOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiMetricOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" + } + ] + }, "JsonApiVisualizationObjectOutList": { "description": "A JSON:API document with a list of resources", "properties": { @@ -25471,7 +25469,7 @@ "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiMetricOutIncludes" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutIncludes" }, "type": "array", "uniqueItems": true @@ -27276,10 +27274,10 @@ "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", + "SORT_COLLATION", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -27375,10 +27373,10 @@ "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", + "SORT_COLLATION", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -27540,10 +27538,10 @@ "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", + "SORT_COLLATION", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -27639,10 +27637,10 @@ "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", + "SORT_COLLATION", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -28050,10 +28048,9 @@ "$ref": "#/components/schemas/OpenAiProviderAuth" }, "baseUrl": { - "default": "https://api.openai.com", + "default": "https://api.openai.com/v1", "description": "Custom base URL for OpenAI API.", "maxLength": 255, - "nullable": true, "type": "string" }, "organization": { @@ -29132,10 +29129,10 @@ "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", + "SORT_COLLATION", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -29312,6 +29309,16 @@ "example": true, "type": "boolean" }, + "grandTotalsPosition": { + "description": "Grand totals position. Takes precedence over position specified in visualization.", + "enum": [ + "pinnedBottom", + "pinnedTop", + "bottom", + "top" + ], + "type": "string" + }, "mergeHeaders": { "description": "Merge equal headers in neighbouring cells. (XLSX)", "example": true, @@ -32856,7 +32863,7 @@ "tags": [ "Cookie Security Configuration", "entities", - "organization-controller" + "cookie-security-configuration-controller" ] }, "patch": { @@ -32911,7 +32918,7 @@ "tags": [ "Cookie Security Configuration", "entities", - "organization-controller" + "cookie-security-configuration-controller" ] }, "put": { @@ -32966,7 +32973,7 @@ "tags": [ "Cookie Security Configuration", "entities", - "organization-controller" + "cookie-security-configuration-controller" ] } }, @@ -33054,7 +33061,7 @@ "tags": [ "Organization - Entity APIs", "entities", - "organization-controller" + "organization-entity-controller" ], "x-gdc-security-info": { "description": "Contains permissions required to manipulate the Organization.", @@ -33139,7 +33146,7 @@ "tags": [ "Organization - Entity APIs", "entities", - "organization-controller" + "organization-entity-controller" ], "x-gdc-security-info": { "description": "Contains permissions required to manipulate the Organization.", @@ -33224,7 +33231,7 @@ "tags": [ "Organization - Entity APIs", "entities", - "organization-controller" + "organization-entity-controller" ], "x-gdc-security-info": { "description": "Contains permissions required to manipulate the Organization.", @@ -33908,10 +33915,11 @@ "description": "Request successfully processed" } }, + "summary": "Get all Custom Geo Collections", "tags": [ "Geographic Data", "entities", - "organization-model-controller" + "custom-geo-collection-controller" ] }, "post": { @@ -33948,10 +33956,11 @@ "description": "Request successfully processed" } }, + "summary": "Post Custom Geo Collections", "tags": [ "Geographic Data", "entities", - "organization-model-controller" + "custom-geo-collection-controller" ] } }, @@ -33977,10 +33986,11 @@ "$ref": "#/components/responses/Deleted" } }, + "summary": "Delete Custom Geo Collection", "tags": [ "Geographic Data", "entities", - "organization-model-controller" + "custom-geo-collection-controller" ] }, "get": { @@ -34016,10 +34026,11 @@ "description": "Request successfully processed" } }, + "summary": "Get Custom Geo Collection", "tags": [ "Geographic Data", "entities", - "organization-model-controller" + "custom-geo-collection-controller" ] }, "patch": { @@ -34070,10 +34081,11 @@ "description": "Request successfully processed" } }, + "summary": "Patch Custom Geo Collection", "tags": [ "Geographic Data", "entities", - "organization-model-controller" + "custom-geo-collection-controller" ] }, "put": { @@ -34124,10 +34136,11 @@ "description": "Request successfully processed" } }, + "summary": "Put Custom Geo Collection", "tags": [ "Geographic Data", "entities", - "organization-model-controller" + "custom-geo-collection-controller" ] } }, @@ -34346,7 +34359,7 @@ "tags": [ "Data Source - Entity APIs", "entities", - "organization-model-controller" + "data-source-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -34418,7 +34431,7 @@ "tags": [ "Data Source - Entity APIs", "entities", - "organization-model-controller" + "data-source-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -34455,7 +34468,7 @@ "tags": [ "Data Source - Entity APIs", "entities", - "organization-model-controller" + "data-source-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -34524,7 +34537,7 @@ "tags": [ "Data Source - Entity APIs", "entities", - "organization-model-controller" + "data-source-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -34586,7 +34599,7 @@ "tags": [ "Data Source - Entity APIs", "entities", - "organization-model-controller" + "data-source-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -34648,7 +34661,7 @@ "tags": [ "Data Source - Entity APIs", "entities", - "organization-model-controller" + "data-source-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -35445,7 +35458,7 @@ "tags": [ "JWKS", "entities", - "organization-model-controller" + "jwk-controller" ] }, "post": { @@ -35487,7 +35500,7 @@ "tags": [ "JWKS", "entities", - "organization-model-controller" + "jwk-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -35524,7 +35537,7 @@ "tags": [ "JWKS", "entities", - "organization-model-controller" + "jwk-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -35571,7 +35584,7 @@ "tags": [ "JWKS", "entities", - "organization-model-controller" + "jwk-controller" ] }, "patch": { @@ -35627,7 +35640,7 @@ "tags": [ "JWKS", "entities", - "organization-model-controller" + "jwk-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -35689,7 +35702,7 @@ "tags": [ "JWKS", "entities", - "organization-model-controller" + "jwk-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -38533,7 +38546,7 @@ "tags": [ "API tokens", "entities", - "user-model-controller" + "api-token-controller" ] }, "post": { @@ -38584,7 +38597,7 @@ "tags": [ "API tokens", "entities", - "user-model-controller" + "api-token-controller" ] } }, @@ -38622,7 +38635,7 @@ "tags": [ "API tokens", "entities", - "user-model-controller" + "api-token-controller" ] }, "get": { @@ -38670,7 +38683,7 @@ "tags": [ "API tokens", "entities", - "user-model-controller" + "api-token-controller" ] } }, @@ -38748,7 +38761,7 @@ "tags": [ "User Settings", "entities", - "user-model-controller" + "user-setting-controller" ] }, "post": { @@ -38799,7 +38812,7 @@ "tags": [ "User Settings", "entities", - "user-model-controller" + "user-setting-controller" ] } }, @@ -38837,7 +38850,7 @@ "tags": [ "User Settings", "entities", - "user-model-controller" + "user-setting-controller" ] }, "get": { @@ -38885,7 +38898,7 @@ "tags": [ "User Settings", "entities", - "user-model-controller" + "user-setting-controller" ] }, "put": { @@ -38948,7 +38961,7 @@ "tags": [ "User Settings", "entities", - "user-model-controller" + "user-setting-controller" ] } }, @@ -39875,7 +39888,7 @@ "tags": [ "Dashboards", "entities", - "workspace-object-controller" + "analytical-dashboard-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -39985,7 +39998,7 @@ "tags": [ "Dashboards", "entities", - "workspace-object-controller" + "analytical-dashboard-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -40060,11 +40073,11 @@ "description": "Request successfully processed" } }, - "summary": "Search request for AnalyticalDashboard", + "summary": "The search endpoint (beta)", "tags": [ "Dashboards", "entities", - "workspace-object-controller" + "analytical-dashboard-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -40113,7 +40126,7 @@ "tags": [ "Dashboards", "entities", - "workspace-object-controller" + "analytical-dashboard-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -40234,7 +40247,7 @@ "tags": [ "Dashboards", "entities", - "workspace-object-controller" + "analytical-dashboard-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -40337,7 +40350,7 @@ "tags": [ "Dashboards", "entities", - "workspace-object-controller" + "analytical-dashboard-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -40440,7 +40453,7 @@ "tags": [ "Dashboards", "entities", - "workspace-object-controller" + "analytical-dashboard-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -40571,7 +40584,7 @@ "tags": [ "Attribute Hierarchies", "entities", - "workspace-object-controller" + "attribute-hierarchy-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -40672,7 +40685,7 @@ "tags": [ "Attribute Hierarchies", "entities", - "workspace-object-controller" + "attribute-hierarchy-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -40747,11 +40760,11 @@ "description": "Request successfully processed" } }, - "summary": "Search request for AttributeHierarchy", + "summary": "The search endpoint (beta)", "tags": [ "Attribute Hierarchies", "entities", - "workspace-object-controller" + "attribute-hierarchy-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -40800,7 +40813,7 @@ "tags": [ "Attribute Hierarchies", "entities", - "workspace-object-controller" + "attribute-hierarchy-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -40912,7 +40925,7 @@ "tags": [ "Attribute Hierarchies", "entities", - "workspace-object-controller" + "attribute-hierarchy-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -41008,7 +41021,7 @@ "tags": [ "Attribute Hierarchies", "entities", - "workspace-object-controller" + "attribute-hierarchy-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -41104,7 +41117,7 @@ "tags": [ "Attribute Hierarchies", "entities", - "workspace-object-controller" + "attribute-hierarchy-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -41236,8 +41249,14 @@ "tags": [ "Attributes", "entities", - "workspace-object-controller" - ] + "attribute-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } } }, "/api/v1/entities/workspaces/{workspaceId}/attributes/search": { @@ -41305,12 +41324,18 @@ "description": "Request successfully processed" } }, - "summary": "Search request for Attribute", + "summary": "The search endpoint (beta)", "tags": [ "Attributes", "entities", - "workspace-object-controller" - ] + "attribute-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } } }, "/api/v1/entities/workspaces/{workspaceId}/attributes/{objectId}": { @@ -41418,8 +41443,14 @@ "tags": [ "Attributes", "entities", - "workspace-object-controller" - ] + "attribute-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } }, "patch": { "operationId": "patchEntity@Attributes", @@ -41509,8 +41540,14 @@ "tags": [ "Attributes", "entities", - "workspace-object-controller" - ] + "attribute-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } } }, "/api/v1/entities/workspaces/{workspaceId}/automationResults/search": { @@ -41714,7 +41751,7 @@ "tags": [ "Automations", "entities", - "workspace-object-controller" + "automation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -41822,7 +41859,7 @@ "tags": [ "Automations", "entities", - "workspace-object-controller" + "automation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -41897,11 +41934,11 @@ "description": "Request successfully processed" } }, - "summary": "Search request for Automation", + "summary": "The search endpoint (beta)", "tags": [ "Automations", "entities", - "workspace-object-controller" + "automation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -41950,7 +41987,7 @@ "tags": [ "Automations", "entities", - "workspace-object-controller" + "automation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -42069,7 +42106,7 @@ "tags": [ "Automations", "entities", - "workspace-object-controller" + "automation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -42172,7 +42209,7 @@ "tags": [ "Automations", "entities", - "workspace-object-controller" + "automation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -42275,7 +42312,7 @@ "tags": [ "Automations", "entities", - "workspace-object-controller" + "automation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -42384,7 +42421,7 @@ "tags": [ "Workspaces - Settings", "entities", - "workspace-object-controller" + "custom-application-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -42463,7 +42500,7 @@ "tags": [ "Workspaces - Settings", "entities", - "workspace-object-controller" + "custom-application-setting-controller" ] } }, @@ -42532,11 +42569,11 @@ "description": "Request successfully processed" } }, - "summary": "Search request for CustomApplicationSetting", + "summary": "The search endpoint (beta)", "tags": [ "Workspaces - Settings", "entities", - "workspace-object-controller" + "custom-application-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -42585,7 +42622,7 @@ "tags": [ "Workspaces - Settings", "entities", - "workspace-object-controller" + "custom-application-setting-controller" ] }, "get": { @@ -42669,7 +42706,7 @@ "tags": [ "Workspaces - Settings", "entities", - "workspace-object-controller" + "custom-application-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -42743,7 +42780,7 @@ "tags": [ "Workspaces - Settings", "entities", - "workspace-object-controller" + "custom-application-setting-controller" ] }, "put": { @@ -42811,7 +42848,7 @@ "tags": [ "Workspaces - Settings", "entities", - "workspace-object-controller" + "custom-application-setting-controller" ] } }, @@ -42935,7 +42972,7 @@ "tags": [ "Plugins", "entities", - "workspace-object-controller" + "dashboard-plugin-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -43035,7 +43072,7 @@ "tags": [ "Plugins", "entities", - "workspace-object-controller" + "dashboard-plugin-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -43110,11 +43147,11 @@ "description": "Request successfully processed" } }, - "summary": "Search request for DashboardPlugin", + "summary": "The search endpoint (beta)", "tags": [ "Plugins", "entities", - "workspace-object-controller" + "dashboard-plugin-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -43163,7 +43200,7 @@ "tags": [ "Plugins", "entities", - "workspace-object-controller" + "dashboard-plugin-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -43274,7 +43311,7 @@ "tags": [ "Plugins", "entities", - "workspace-object-controller" + "dashboard-plugin-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -43369,7 +43406,7 @@ "tags": [ "Plugins", "entities", - "workspace-object-controller" + "dashboard-plugin-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -43464,7 +43501,7 @@ "tags": [ "Plugins", "entities", - "workspace-object-controller" + "dashboard-plugin-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -43597,8 +43634,14 @@ "tags": [ "Datasets", "entities", - "workspace-object-controller" - ] + "dataset-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } } }, "/api/v1/entities/workspaces/{workspaceId}/datasets/search": { @@ -43666,12 +43709,18 @@ "description": "Request successfully processed" } }, - "summary": "Search request for Dataset", + "summary": "The search endpoint (beta)", "tags": [ "Datasets", "entities", - "workspace-object-controller" - ] + "dataset-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } } }, "/api/v1/entities/workspaces/{workspaceId}/datasets/{objectId}": { @@ -43780,8 +43829,14 @@ "tags": [ "Datasets", "entities", - "workspace-object-controller" - ] + "dataset-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } }, "patch": { "operationId": "patchEntity@Datasets", @@ -43872,8 +43927,14 @@ "tags": [ "Datasets", "entities", - "workspace-object-controller" - ] + "dataset-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } } }, "/api/v1/entities/workspaces/{workspaceId}/exportDefinitions": { @@ -44002,7 +44063,7 @@ "tags": [ "Export Definitions", "entities", - "workspace-object-controller" + "export-definition-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -44108,7 +44169,7 @@ "tags": [ "Export Definitions", "entities", - "workspace-object-controller" + "export-definition-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -44183,11 +44244,11 @@ "description": "Request successfully processed" } }, - "summary": "Search request for ExportDefinition", + "summary": "The search endpoint (beta)", "tags": [ "Export Definitions", "entities", - "workspace-object-controller" + "export-definition-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -44236,7 +44297,7 @@ "tags": [ "Export Definitions", "entities", - "workspace-object-controller" + "export-definition-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -44353,7 +44414,7 @@ "tags": [ "Export Definitions", "entities", - "workspace-object-controller" + "export-definition-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -44454,7 +44515,7 @@ "tags": [ "Export Definitions", "entities", - "workspace-object-controller" + "export-definition-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -44555,7 +44616,7 @@ "tags": [ "Export Definitions", "entities", - "workspace-object-controller" + "export-definition-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -44684,7 +44745,7 @@ "tags": [ "Facts", "entities", - "workspace-object-controller" + "fact-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -44759,11 +44820,11 @@ "description": "Request successfully processed" } }, - "summary": "Search request for Fact", + "summary": "The search endpoint (beta)", "tags": [ "Facts", "entities", - "workspace-object-controller" + "fact-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -44875,7 +44936,7 @@ "tags": [ "Facts", "entities", - "workspace-object-controller" + "fact-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -44969,7 +45030,7 @@ "tags": [ "Facts", "entities", - "workspace-object-controller" + "fact-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -45099,7 +45160,7 @@ "tags": [ "Filter Context", "entities", - "workspace-object-controller" + "filter-context-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -45199,7 +45260,7 @@ "tags": [ "Filter Context", "entities", - "workspace-object-controller" + "filter-context-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -45274,11 +45335,11 @@ "description": "Request successfully processed" } }, - "summary": "Search request for FilterContext", + "summary": "The search endpoint (beta)", "tags": [ "Filter Context", "entities", - "workspace-object-controller" + "filter-context-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -45327,7 +45388,7 @@ "tags": [ "Filter Context", "entities", - "workspace-object-controller" + "filter-context-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -45438,7 +45499,7 @@ "tags": [ "Filter Context", "entities", - "workspace-object-controller" + "filter-context-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -45533,7 +45594,7 @@ "tags": [ "Filter Context", "entities", - "workspace-object-controller" + "filter-context-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -45628,7 +45689,7 @@ "tags": [ "Filter Context", "entities", - "workspace-object-controller" + "filter-context-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -45758,7 +45819,7 @@ "tags": [ "Filter Views", "entities", - "workspace-object-controller" + "filter-view-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -45837,7 +45898,7 @@ "tags": [ "Filter Views", "entities", - "workspace-object-controller" + "filter-view-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage Filter Views", @@ -45912,11 +45973,11 @@ "description": "Request successfully processed" } }, - "summary": "Search request for FilterView", + "summary": "The search endpoint (beta)", "tags": [ "Filter Views", "entities", - "workspace-object-controller" + "filter-view-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -45965,7 +46026,7 @@ "tags": [ "Filter Views", "entities", - "workspace-object-controller" + "filter-view-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage Filter Views", @@ -46055,7 +46116,7 @@ "tags": [ "Filter Views", "entities", - "workspace-object-controller" + "filter-view-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -46151,7 +46212,7 @@ "tags": [ "Filter Views", "entities", - "workspace-object-controller" + "filter-view-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage Filter Views", @@ -46247,7 +46308,7 @@ "tags": [ "Filter Views", "entities", - "workspace-object-controller" + "filter-view-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage Filter Views", @@ -46540,6 +46601,7 @@ "description": "Request successfully processed" } }, + "summary": "The search endpoint (beta)", "tags": [ "AI", "entities", @@ -46991,7 +47053,7 @@ "tags": [ "Labels", "entities", - "workspace-object-controller" + "label-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -47066,11 +47128,11 @@ "description": "Request successfully processed" } }, - "summary": "Search request for Label", + "summary": "The search endpoint (beta)", "tags": [ "Labels", "entities", - "workspace-object-controller" + "label-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -47182,7 +47244,7 @@ "tags": [ "Labels", "entities", - "workspace-object-controller" + "label-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -47276,7 +47338,7 @@ "tags": [ "Labels", "entities", - "workspace-object-controller" + "label-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -48023,7 +48085,7 @@ "tags": [ "Metrics", "entities", - "workspace-object-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -48129,7 +48191,7 @@ "tags": [ "Metrics", "entities", - "workspace-object-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -48204,11 +48266,11 @@ "description": "Request successfully processed" } }, - "summary": "Search request for Metric", + "summary": "The search endpoint (beta)", "tags": [ "Metrics", "entities", - "workspace-object-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -48257,7 +48319,7 @@ "tags": [ "Metrics", "entities", - "workspace-object-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -48374,7 +48436,7 @@ "tags": [ "Metrics", "entities", - "workspace-object-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -48475,7 +48537,7 @@ "tags": [ "Metrics", "entities", - "workspace-object-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -48576,7 +48638,7 @@ "tags": [ "Metrics", "entities", - "workspace-object-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -48712,8 +48774,14 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" - ] + "user-data-filter-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } }, "post": { "operationId": "createEntity@UserDataFilters", @@ -48812,8 +48880,14 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" - ] + "user-data-filter-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } } }, "/api/v1/entities/workspaces/{workspaceId}/userDataFilters/search": { @@ -48881,12 +48955,18 @@ "description": "Request successfully processed" } }, - "summary": "Search request for UserDataFilter", + "summary": "The search endpoint (beta)", "tags": [ "Data Filters", "entities", - "workspace-object-controller" - ] + "user-data-filter-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } } }, "/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}": { @@ -48928,8 +49008,14 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" - ] + "user-data-filter-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } }, "get": { "operationId": "getEntity@UserDataFilters", @@ -49039,8 +49125,14 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" - ] + "user-data-filter-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } }, "patch": { "operationId": "patchEntity@UserDataFilters", @@ -49134,8 +49226,14 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" - ] + "user-data-filter-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } }, "put": { "operationId": "updateEntity@UserDataFilters", @@ -49229,8 +49327,14 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" - ] + "user-data-filter-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } } }, "/api/v1/entities/workspaces/{workspaceId}/visualizationObjects": { @@ -49359,7 +49463,7 @@ "tags": [ "Visualization Object", "entities", - "workspace-object-controller" + "visualization-object-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -49465,7 +49569,7 @@ "tags": [ "Visualization Object", "entities", - "workspace-object-controller" + "visualization-object-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -49540,11 +49644,11 @@ "description": "Request successfully processed" } }, - "summary": "Search request for VisualizationObject", + "summary": "The search endpoint (beta)", "tags": [ "Visualization Object", "entities", - "workspace-object-controller" + "visualization-object-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -49593,7 +49697,7 @@ "tags": [ "Visualization Object", "entities", - "workspace-object-controller" + "visualization-object-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -49710,7 +49814,7 @@ "tags": [ "Visualization Object", "entities", - "workspace-object-controller" + "visualization-object-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -49811,7 +49915,7 @@ "tags": [ "Visualization Object", "entities", - "workspace-object-controller" + "visualization-object-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -49912,7 +50016,7 @@ "tags": [ "Visualization Object", "entities", - "workspace-object-controller" + "visualization-object-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -50041,7 +50145,7 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" + "workspace-data-filter-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -50140,7 +50244,7 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" + "workspace-data-filter-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", @@ -50215,11 +50319,11 @@ "description": "Request successfully processed" } }, - "summary": "Search request for WorkspaceDataFilterSetting", + "summary": "The search endpoint (beta)", "tags": [ "Data Filters", "entities", - "workspace-object-controller" + "workspace-data-filter-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -50268,7 +50372,7 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" + "workspace-data-filter-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", @@ -50378,7 +50482,7 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" + "workspace-data-filter-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -50472,7 +50576,7 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" + "workspace-data-filter-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", @@ -50566,7 +50670,7 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" + "workspace-data-filter-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", @@ -50695,7 +50799,7 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" + "workspace-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -50794,7 +50898,7 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" + "workspace-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", @@ -50869,11 +50973,11 @@ "description": "Request successfully processed" } }, - "summary": "Search request for WorkspaceDataFilter", + "summary": "The search endpoint (beta)", "tags": [ "Data Filters", "entities", - "workspace-object-controller" + "workspace-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -50922,7 +51026,7 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" + "workspace-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", @@ -51032,7 +51136,7 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" + "workspace-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -51126,7 +51230,7 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" + "workspace-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", @@ -51220,7 +51324,7 @@ "tags": [ "Data Filters", "entities", - "workspace-object-controller" + "workspace-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", @@ -51329,7 +51433,7 @@ "tags": [ "Workspaces - Settings", "entities", - "workspace-object-controller" + "workspace-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -51408,7 +51512,7 @@ "tags": [ "Workspaces - Settings", "entities", - "workspace-object-controller" + "workspace-setting-controller" ] } }, @@ -51477,10 +51581,11 @@ "description": "Request successfully processed" } }, + "summary": "The search endpoint (beta)", "tags": [ "Workspaces - Settings", "entities", - "workspace-object-controller" + "workspace-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -51529,7 +51634,7 @@ "tags": [ "Workspaces - Settings", "entities", - "workspace-object-controller" + "workspace-setting-controller" ] }, "get": { @@ -51613,7 +51718,7 @@ "tags": [ "Workspaces - Settings", "entities", - "workspace-object-controller" + "workspace-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -51687,7 +51792,7 @@ "tags": [ "Workspaces - Settings", "entities", - "workspace-object-controller" + "workspace-setting-controller" ] }, "put": { @@ -51755,7 +51860,7 @@ "tags": [ "Workspaces - Settings", "entities", - "workspace-object-controller" + "workspace-setting-controller" ] } }, From a2975903b8c4fc25641f44e7b0e3d79b58da7ced Mon Sep 17 00:00:00 2001 From: Jan Tychtl Date: Thu, 12 Mar 2026 10:15:04 +0100 Subject: [PATCH 2/4] feat(ci): add staging test infrastructure and harden test setup - Add staging test workflow and configuration - Overhaul test conftest and catalog test files for staging support - Add docker-compose env vars, clean_staging and upload_demo_layout scripts - Fix LLM provider patch to use InAttributes after spec change - Add alternativeDataSourceId to data source fixture - Fix docs CI (toml dep, stale artifacts, baseURL, Hugo caching) - Add docs API reference pre-rendering and tests - Add AIDA onboarding artifacts --- .github/workflows/staging-tests.yaml | 76 ++++ .gitignore | 3 + CONTRIBUTING.md | 36 ++ Makefile | 15 + .../organization/entity_model/llm_provider.py | 5 +- .../gooddata-sdk/tests/catalog/conftest.py | 224 ++++++++++ .../tests/catalog/test_catalog_data_source.py | 59 +-- .../catalog/test_catalog_organization.py | 167 ++++---- .../tests/catalog/test_catalog_permission.py | 31 +- .../catalog/test_catalog_user_service.py | 278 ++++++------- .../tests/catalog/test_catalog_workspace.py | 118 +++--- .../catalog/test_catalog_workspace_content.py | 15 +- packages/gooddata-sdk/tests/conftest.py | 392 ++++++++++++++++++ .../tests/gd_test_config_staging.yaml | 32 ++ packages/gooddata-sdk/tox.ini | 3 + packages/tests-support/clean_staging.py | 74 ++++ .../fixtures/demo_data_sources.json | 1 + packages/tests-support/upload_demo_layout.py | 96 ++++- project_common.mk | 5 + 19 files changed, 1269 insertions(+), 361 deletions(-) create mode 100644 .github/workflows/staging-tests.yaml create mode 100644 packages/gooddata-sdk/tests/catalog/conftest.py create mode 100644 packages/gooddata-sdk/tests/gd_test_config_staging.yaml create mode 100644 packages/tests-support/clean_staging.py diff --git a/.github/workflows/staging-tests.yaml b/.github/workflows/staging-tests.yaml new file mode 100644 index 000000000..bdedb18ff --- /dev/null +++ b/.github/workflows/staging-tests.yaml @@ -0,0 +1,76 @@ +name: Staging tests + +on: + pull_request: + types: [labeled] + branches: + - master + - 'rel/**' + issue_comment: + types: [created] + workflow_dispatch: + inputs: + test_envs: + description: 'Tox test environments to run (e.g. py312)' + required: false + default: 'py314' + test_filter: + description: 'Pytest filter expression (-k flag)' + required: false + default: '' + +concurrency: + group: staging-tests + cancel-in-progress: false + +jobs: + staging-tests: + name: Staging tests + if: >- + github.event_name == 'workflow_dispatch' || + (github.event_name == 'pull_request' && github.event.label.name == 'test-staging') || + (github.event_name == 'issue_comment' && github.event.issue.pull_request && contains(github.event.comment.body, '/test-staging')) + runs-on: + group: infra1-runners-arc + labels: runners-small + steps: + - name: Get PR head SHA (comment trigger) + if: github.event_name == 'issue_comment' + id: pr + run: | + PR_DATA=$(gh api repos/${{ github.repository }}/pulls/${{ github.event.issue.number }}) + echo "sha=$(echo "$PR_DATA" | jq -r .head.sha)" >> "$GITHUB_OUTPUT" + echo "ref=$(echo "$PR_DATA" | jq -r .head.ref)" >> "$GITHUB_OUTPUT" + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + - name: Checkout + uses: actions/checkout@v4 + with: + ref: ${{ steps.pr.outputs.sha || github.event.pull_request.head.sha || github.sha }} + + - name: Set up Python + uses: astral-sh/setup-uv@v6 + with: + python-version: '3.14' + + - name: Install dependencies + run: uv sync --all-groups --locked + + - name: Clean staging environment + run: make clean-staging + env: + TOKEN: ${{ secrets.PYTHON_SDK_STG_API_KEY }} + + - name: Load staging environment + run: make load-staging + env: + TOKEN: ${{ secrets.PYTHON_SDK_STG_API_KEY }} + + - name: Run staging tests + run: | + make test-staging \ + TEST_ENVS=${{ github.event.inputs.test_envs || 'py314' }} \ + ADD_ARGS="${{ github.event.inputs.test_filter && format('-k {0}', github.event.inputs.test_filter) || '' }}" + env: + TOKEN: ${{ secrets.PYTHON_SDK_STG_API_KEY }} diff --git a/.gitignore b/.gitignore index 1268f15ab..76ba04099 100644 --- a/.gitignore +++ b/.gitignore @@ -34,3 +34,6 @@ docs/.hugo_build.lock # Export artifacts from Docker export-controller service packages/gooddata-sdk/tests/export/exports/default/ + +# Staging test fixture backups (created by conftest.py, self-heal on next run) +*.staging-backup diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c3c2c0ea3..4528e1ea0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -292,6 +292,42 @@ docker compose --profile fdw up -d This starts a PostgreSQL instance with the gooddata-fdw extension on port 2543. +## Run staging tests + +Staging tests run against a shared GoodData staging environment instead of a local docker-compose stack. +They are useful for validating changes against a real deployment. + +### Triggers + +The staging tests workflow (`.github/workflows/staging-tests.yaml`) can be triggered in three ways: + +1. **Label** — Add the `test-staging` label to a PR targeting `master` or `rel/**`. +2. **PR comment** — Post `/test-staging` as a comment on a PR. +3. **Manual dispatch** — Trigger from the Actions tab with optional `test_envs` and `test_filter` inputs. + +Only one staging test run executes at a time (concurrency group `staging-tests`, non-cancelling). + +### Running staging tests locally + +You need a staging API token (`TOKEN`). The workflow uses the `PYTHON_SDK_STG_API_KEY` secret; locally you +pass it via the `TOKEN=` make argument: + +```bash +# 1. Clean the staging workspace (removes previous test data) +make clean-staging TOKEN= + +# 2. Load the demo layout into staging +make load-staging TOKEN= + +# 3. Run the tests +make test-staging TOKEN= + +# Optionally limit python version and test filter: +make test-staging TOKEN= TEST_ENVS=py312 ADD_ARGS="-k test_catalog" +``` + +The token is passed as a CLI argument (`--gd-test-token`) to pytest, **not** as an environment variable. + ## Run continuous integration tests Tests in pull request (PR) are executed using docker. The following is done to make test environment as close to reproducible as possible: diff --git a/Makefile b/Makefile index bbb2f2c6c..cc87cf97c 100644 --- a/Makefile +++ b/Makefile @@ -82,6 +82,21 @@ test: for project in $(NO_CLIENT_GD_PROJECTS_DIRS); do $(MAKE) -C packages/$${project} test || RESULT=$$?; done; \ exit $$RESULT +.PHONY: test-staging +test-staging: + @test -n "$(TOKEN)" || (echo "ERROR: TOKEN is required. Usage: make test-staging TOKEN=" && exit 1) + $(MAKE) -C packages/gooddata-sdk test-staging TOKEN=$(TOKEN) + +.PHONY: clean-staging +clean-staging: + @test -n "$(TOKEN)" || (echo "ERROR: TOKEN is required. Usage: make clean-staging TOKEN=" && exit 1) + cd packages/tests-support && STAGING=1 TOKEN="$(TOKEN)" python clean_staging.py + +.PHONY: load-staging +load-staging: + @test -n "$(TOKEN)" || (echo "ERROR: TOKEN is required. Usage: make load-staging TOKEN=" && exit 1) + cd packages/tests-support && STAGING=1 TOKEN="$(TOKEN)" python upload_demo_layout.py + .PHONY: release release: if [ -z "$(VERSION)" ]; then echo "Usage: 'make release VERSION=X.Y.Z'"; false; else \ diff --git a/packages/gooddata-sdk/src/gooddata_sdk/catalog/organization/entity_model/llm_provider.py b/packages/gooddata-sdk/src/gooddata_sdk/catalog/organization/entity_model/llm_provider.py index 0146b8f9b..063479a89 100644 --- a/packages/gooddata-sdk/src/gooddata_sdk/catalog/organization/entity_model/llm_provider.py +++ b/packages/gooddata-sdk/src/gooddata_sdk/catalog/organization/entity_model/llm_provider.py @@ -15,7 +15,6 @@ ) from gooddata_api_client.model.json_api_llm_provider_in_document import JsonApiLlmProviderInDocument from gooddata_api_client.model.json_api_llm_provider_patch import JsonApiLlmProviderPatch -from gooddata_api_client.model.json_api_llm_provider_patch_attributes import JsonApiLlmProviderPatchAttributes from gooddata_api_client.model.json_api_llm_provider_patch_document import JsonApiLlmProviderPatchDocument from gooddata_api_client.model.open_ai_provider_auth import OpenAiProviderAuth from gooddata_api_client.model.open_ai_provider_config import OpenAIProviderConfig @@ -332,5 +331,5 @@ class CatalogLlmProviderPatchAttributes(Base): default_model_id: str | None = None @staticmethod - def client_class() -> type[JsonApiLlmProviderPatchAttributes]: - return JsonApiLlmProviderPatchAttributes + def client_class() -> type[JsonApiLlmProviderInAttributes]: + return JsonApiLlmProviderInAttributes diff --git a/packages/gooddata-sdk/tests/catalog/conftest.py b/packages/gooddata-sdk/tests/catalog/conftest.py new file mode 100644 index 000000000..52d714397 --- /dev/null +++ b/packages/gooddata-sdk/tests/catalog/conftest.py @@ -0,0 +1,224 @@ +# (C) 2024 GoodData Corporation +""" +Shared test fixtures for catalog tests. + +Provides: +- safe_delete: cleanup utility that swallows exceptions +- sdk: session-scoped GoodDataSdk instance +- Snapshot/restore fixtures for staging-safe testing +""" + +from __future__ import annotations + +import logging +from pathlib import Path +from typing import Any, Callable + +import pytest +from gooddata_sdk import GoodDataSdk + +logger = logging.getLogger(__name__) + +_current_dir = Path(__file__).parent.absolute() +_credentials_path = _current_dir / "load" / "data_source_credentials" / "data_sources_credentials.yaml" + + +def _capture_workspace_permissions(sdk: GoodDataSdk, workspaces: list) -> dict: + """Capture permissions for all workspaces, skipping failures.""" + ws_permissions: dict = {} + for ws in workspaces: + try: + ws_permissions[ws.id] = sdk.catalog_permission.get_declarative_permissions(ws.id) + except Exception as e: # noqa: PERF203 + logger.warning(f"Could not capture permissions for workspace {ws.id}: {e}") + return ws_permissions + + +def _restore_workspace_permissions(sdk: GoodDataSdk, ws_permissions: dict) -> None: + """Restore permissions for all workspaces, logging failures.""" + for ws_id, perms in ws_permissions.items(): + try: + sdk.catalog_permission.put_declarative_permissions(ws_id, perms) + except Exception as e: # noqa: PERF203 + logger.warning(f"RESTORE FAILED [permissions for {ws_id}]: {e}") + + +def safe_delete(func: Callable, *args: Any, **kwargs: Any) -> None: + """Call a cleanup function, swallowing any exception so it doesn't mask test failures. + + Use this in `finally` blocks instead of bare cleanup calls. + """ + try: + func(*args, **kwargs) + except Exception as e: + logger.warning(f"Cleanup failed (ignored): {type(e).__name__}: {e}") + + +@pytest.fixture(scope="session") +def sdk(test_config): + """Session-scoped GoodDataSdk instance.""" + return GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"]) + + +# --------------------------------------------------------------------------- +# Snapshot/restore fixtures +# +# Each fixture captures the current live state via GET before the test runs, +# yields it for the test to use, then restores via PUT in teardown. +# This is environment-agnostic: works against Docker, staging, or anything else. +# --------------------------------------------------------------------------- + + +@pytest.fixture() +def snapshot_workspaces(sdk): + """Capture all workspaces, restore after test. + + Silently yields None if the server is unreachable (VCR replay mode). + """ + try: + original = sdk.catalog_workspace.get_declarative_workspaces(exclude=["ACTIVITY_INFO"]) + except Exception as e: + logger.debug(f"snapshot_workspaces: server unreachable, skipping ({e})") + yield None + return + yield original + try: + sdk.catalog_workspace.put_declarative_workspaces(original) + except Exception as e: + logger.error(f"RESTORE FAILED [workspaces]: {e}") + + +@pytest.fixture() +def snapshot_workspace_data_filters(sdk): + """Capture workspace data filters, restore after test. + + Silently yields None if the server is unreachable (VCR replay mode). + """ + try: + original = sdk.catalog_workspace.get_declarative_workspace_data_filters() + except Exception as e: + logger.debug(f"snapshot_workspace_data_filters: server unreachable, skipping ({e})") + yield None + return + yield original + try: + sdk.catalog_workspace.put_declarative_workspace_data_filters(original) + except Exception as e: + logger.error(f"RESTORE FAILED [workspace_data_filters]: {e}") + + +@pytest.fixture() +def snapshot_data_sources(sdk): + """Capture all data sources, restore after test. + + Silently yields None if the server is unreachable (VCR replay mode). + """ + try: + original = sdk.catalog_data_source.get_declarative_data_sources() + except Exception as e: + logger.debug(f"snapshot_data_sources: server unreachable, skipping ({e})") + yield None + return + yield original + try: + sdk.catalog_data_source.put_declarative_data_sources(original, _credentials_path) + except Exception as e: + logger.error(f"RESTORE FAILED [data_sources]: {e}") + + +@pytest.fixture() +def snapshot_notification_channels(sdk): + """Capture notification channels, restore after test. + + Silently yields None if the server is unreachable (VCR replay mode). + """ + try: + original = sdk.catalog_organization.get_declarative_notification_channels() + except Exception as e: + logger.debug(f"snapshot_notification_channels: server unreachable, skipping ({e})") + yield None + return + yield original + try: + sdk.catalog_organization.put_declarative_notification_channels(original) + except Exception as e: + logger.error(f"RESTORE FAILED [notification_channels]: {e}") + + +@pytest.fixture() +def snapshot_org_permissions(sdk): + """Capture organization permissions, restore after test. + + Silently yields None if the server is unreachable (VCR replay mode). + """ + try: + original = sdk.catalog_permission.get_declarative_organization_permissions() + except Exception as e: + logger.debug(f"snapshot_org_permissions: server unreachable, skipping ({e})") + yield None + return + yield original + try: + sdk.catalog_permission.put_declarative_organization_permissions(original) + except Exception as e: + logger.error(f"RESTORE FAILED [org_permissions]: {e}") + + +@pytest.fixture() +def snapshot_permissions(sdk, test_config): + """Capture workspace permissions for the test workspace, restore after test. + + Silently yields None if the server is unreachable (VCR replay mode). + """ + ws_id = test_config["workspace"] + try: + original = sdk.catalog_permission.get_declarative_permissions(ws_id) + except Exception as e: + logger.debug(f"snapshot_permissions: server unreachable, skipping ({e})") + yield None + return + yield original + try: + sdk.catalog_permission.put_declarative_permissions(ws_id, original) + except Exception as e: + logger.error(f"RESTORE FAILED [permissions for {ws_id}]: {e}") + + +@pytest.fixture() +def snapshot_full_user_context(sdk): + """Capture users, groups, AND their permission references. + + Needed for tests that nuke users/groups, because deleting a user + cascade-deletes permissions referencing that user. + + Restores in correct order: users/groups first, then workspace permissions. + Silently yields None if the server is unreachable (VCR replay mode). + """ + try: + users_groups = sdk.catalog_user.get_declarative_users_user_groups() + except Exception as e: + logger.debug(f"snapshot_full_user_context: server unreachable, skipping ({e})") + yield None + return + + workspaces = sdk.catalog_workspace.list_workspaces() + ws_permissions = _capture_workspace_permissions(sdk, workspaces) + + data_sources = sdk.catalog_data_source.get_declarative_data_sources() + + yield users_groups + + # Restore users and groups first + try: + sdk.catalog_user.put_declarative_users_user_groups(users_groups) + except Exception as e: + logger.error(f"RESTORE FAILED [users_user_groups]: {e}") + + # Restore data sources (includes DS-level permissions) + try: + sdk.catalog_data_source.put_declarative_data_sources(data_sources, _credentials_path) + except Exception as e: + logger.error(f"RESTORE FAILED [data_sources]: {e}") + + # Restore workspace permissions + _restore_workspace_permissions(sdk, ws_permissions) diff --git a/packages/gooddata-sdk/tests/catalog/test_catalog_data_source.py b/packages/gooddata-sdk/tests/catalog/test_catalog_data_source.py index 67f9f42d0..c1684ee05 100644 --- a/packages/gooddata-sdk/tests/catalog/test_catalog_data_source.py +++ b/packages/gooddata-sdk/tests/catalog/test_catalog_data_source.py @@ -48,6 +48,8 @@ from tests_support.file_utils import load_json from tests_support.vcrpy_utils import get_vcr +from .conftest import safe_delete + gd_vcr = get_vcr() _current_dir = Path(__file__).parent.absolute() @@ -231,8 +233,8 @@ def test_catalog_list_data_sources(test_config): sdk = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"]) data_sources = sdk.catalog_data_source.list_data_sources() - assert len(data_sources) == 1 - assert data_sources[0].id == test_config["data_source"] + assert len(data_sources) >= 1 + assert any(ds.id == test_config["data_source"] for ds in data_sources) def _create_default_data_source(sdk: GoodDataSdk, data_source_id: str = "test"): @@ -263,9 +265,9 @@ def _get_data_source(data_sources: list[CatalogDataSource], data_source_id: str) def test_catalog_create_update_list_data_source(test_config): sdk = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"]) try: - data_sources = sdk.catalog_data_source.list_data_sources() - assert len(data_sources) == 1 - assert data_sources[0].id == test_config["data_source"] + data_sources_before = sdk.catalog_data_source.list_data_sources() + initial_count = len(data_sources_before) + assert any(ds.id == test_config["data_source"] for ds in data_sources_before) _create_default_data_source(sdk) @@ -284,7 +286,7 @@ def test_catalog_create_update_list_data_source(test_config): sdk.catalog_data_source.create_or_update_data_source(updated_data_source) data_sources = sdk.catalog_data_source.list_data_sources() - assert len(data_sources) == 2 + assert len(data_sources) == initial_count + 1 demo_ds = _get_data_source(data_sources, test_config["data_source"]) assert demo_ds assert demo_ds.id == test_config["data_source"] @@ -292,9 +294,7 @@ def test_catalog_create_update_list_data_source(test_config): assert updated_data_source == test_ds finally: # Cleanup every time - sdk.catalog_data_source.delete_data_source("test") - data_sources = sdk.catalog_data_source.list_data_sources() - assert len(data_sources) == 1 + safe_delete(sdk.catalog_data_source.delete_data_source, "test") def _create_delete_ds(sdk, data_source: CatalogDataSource): @@ -303,7 +303,7 @@ def _create_delete_ds(sdk, data_source: CatalogDataSource): created_ds = sdk.catalog_data_source.get_data_source(data_source.id) assert data_source == created_ds finally: - sdk.catalog_data_source.delete_data_source(data_source.id) + safe_delete(sdk.catalog_data_source.delete_data_source, data_source.id) @gd_vcr.use_cassette(str(_fixtures_dir / "redshift.yaml")) @@ -383,6 +383,8 @@ def test_catalog_create_data_source_snowflake_spec(test_config): @gd_vcr.use_cassette(str(_fixtures_dir / "bigquery.yaml")) def test_catalog_create_data_source_bigquery_spec(test_config): + if test_config.get("staging", False) and not test_config.get("bigquery_token_file"): + pytest.skip("BigQuery credentials not available on staging") sdk = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"]) with mock.patch("builtins.open", mock.mock_open(read_data=test_config["bigquery_token_file"].encode("utf-8"))): _create_delete_ds( @@ -423,9 +425,8 @@ def test_catalog_create_data_source_dremio_spec(test_config): def test_catalog_patch_data_source(test_config): sdk = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"]) try: - data_sources = sdk.catalog_data_source.list_data_sources() - assert len(data_sources) == 1 - assert data_sources[0].id == test_config["data_source"] + data_sources_before = sdk.catalog_data_source.list_data_sources() + assert any(ds.id == test_config["data_source"] for ds in data_sources_before) _create_default_data_source(sdk) @@ -440,11 +441,11 @@ def test_catalog_patch_data_source(test_config): assert patched_data_source.name == "Test2" assert patched_data_source.alternative_data_source_id == "ds-patch-abc-id" finally: - sdk.catalog_data_source.delete_data_source("test") + safe_delete(sdk.catalog_data_source.delete_data_source, "test") @gd_vcr.use_cassette(str(_fixtures_dir / "demo_delete_declarative_data_sources.yaml")) -def test_delete_declarative_data_sources(test_config): +def test_delete_declarative_data_sources(test_config, snapshot_data_sources): sdk = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"]) credentials_path = _current_dir / "load" / "data_source_credentials" / "data_sources_credentials.yaml" expected_json_path = _current_dir / "expected" / "declarative_data_sources.json" @@ -468,7 +469,8 @@ def token_from_file_side_effect(file_path: Union[str, Path], base64_encode: bool assert len(data_sources_o.data_sources) == 0 finally: data_sources_o = CatalogDeclarativeDataSources.from_dict(load_json(expected_json_path)) - sdk.catalog_data_source.put_declarative_data_sources(data_sources_o, credentials_path) + safe_delete(sdk.catalog_data_source.put_declarative_data_sources, data_sources_o, credentials_path) + # snapshot_data_sources fixture also restores in teardown @gd_vcr.use_cassette(str(_fixtures_dir / "demo_store_declarative_data_sources.yaml")) @@ -485,7 +487,12 @@ def test_store_declarative_data_sources(test_config): @gd_vcr.use_cassette(str(_fixtures_dir / "demo_load_and_put_declarative_data_sources.yaml")) -def test_load_and_put_declarative_data_sources(test_config): +def test_load_and_put_declarative_data_sources(test_config, snapshot_data_sources): + if test_config.get("staging", False): + # load_and_put loads ALL data sources from the layout directory in a single PUT, + # including bigquery/databricks with dummy credentials. Staging validates credential + # formats and rejects them (400). Can't exclude individual data sources from the PUT. + pytest.skip("Staging server validates credential formats; this test uses mocked dummy credentials") load_folder = _current_dir / "load" sdk = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"]) credentials_path = _current_dir / "load" / "data_source_credentials" / "data_sources_credentials.yaml" @@ -527,11 +534,12 @@ def token_from_file_side_effect(file_path: Union[str, Path], base64_encode: bool finally: data_sources_o = CatalogDeclarativeDataSources.from_dict(load_json(expected_json_path)) sdk2 = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"]) - sdk2.catalog_data_source.put_declarative_data_sources(data_sources_o, credentials_path) + safe_delete(sdk2.catalog_data_source.put_declarative_data_sources, data_sources_o, credentials_path) + # snapshot_data_sources fixture also restores in teardown @gd_vcr.use_cassette(str(_fixtures_dir / "demo_put_declarative_data_sources_connection.yaml")) -def test_put_declarative_data_sources_connection(test_config): +def test_put_declarative_data_sources_connection(test_config, snapshot_data_sources): sdk = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"]) path = _current_dir / "expected" / "declarative_data_sources.json" credentials_path = _current_dir / "load" / "data_source_credentials" / "data_sources_credentials.yaml" @@ -559,11 +567,12 @@ def token_from_file_side_effect(file_path: Union[str, Path], base64_encode: bool assert data_sources_e.to_dict(camel_case=True) == data_sources_o.to_dict(camel_case=True) finally: data_sources_o = CatalogDeclarativeDataSources.from_dict(load_json(path)) - sdk.catalog_data_source.put_declarative_data_sources(data_sources_o, credentials_path) + safe_delete(sdk.catalog_data_source.put_declarative_data_sources, data_sources_o, credentials_path) + # snapshot_data_sources fixture also restores in teardown @gd_vcr.use_cassette(str(_fixtures_dir / "demo_put_declarative_data_sources.yaml")) -def test_put_declarative_data_sources(test_config): +def test_put_declarative_data_sources(test_config, snapshot_data_sources): sdk = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"]) path = _current_dir / "expected" / "declarative_data_sources.json" credentials_path = _current_dir / "load" / "data_source_credentials" / "data_sources_credentials.yaml" @@ -576,7 +585,8 @@ def test_put_declarative_data_sources(test_config): assert data_sources_e.to_dict(camel_case=True) == data_sources_o.to_dict(camel_case=True) finally: data_sources_o = CatalogDeclarativeDataSources.from_dict(load_json(path)) - sdk.catalog_data_source.put_declarative_data_sources(data_sources_o, credentials_path) + safe_delete(sdk.catalog_data_source.put_declarative_data_sources, data_sources_o, credentials_path) + # snapshot_data_sources fixture also restores in teardown @gd_vcr.use_cassette(str(_fixtures_dir / "demo_test_declarative_data_sources.yaml")) @@ -632,7 +642,7 @@ def test_declarative_data_sources_databricks_token(test_config): @gd_vcr.use_cassette(str(_fixtures_dir / "demo_cache_strategy.yaml")) -def test_cache_strategy(test_config: dict): +def test_cache_strategy(test_config: dict, snapshot_data_sources): sdk = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"]) data_source_id = test_config["data_source"] path = _current_dir / "expected" / "declarative_data_sources.json" @@ -657,7 +667,8 @@ def token_from_file_side_effect(file_path: Union[str, Path], base64_encode: bool assert updated.cache_strategy == "NEVER" finally: data_sources_o = CatalogDeclarativeDataSources.from_dict(load_json(path)) - sdk.catalog_data_source.put_declarative_data_sources(data_sources_o, credentials_path) + safe_delete(sdk.catalog_data_source.put_declarative_data_sources, data_sources_o, credentials_path) + # snapshot_data_sources fixture also restores in teardown @gd_vcr.use_cassette(str(_fixtures_dir / "demo_test_scan_model.yaml")) diff --git a/packages/gooddata-sdk/tests/catalog/test_catalog_organization.py b/packages/gooddata-sdk/tests/catalog/test_catalog_organization.py index 58d4d2b66..48051dc4f 100644 --- a/packages/gooddata-sdk/tests/catalog/test_catalog_organization.py +++ b/packages/gooddata-sdk/tests/catalog/test_catalog_organization.py @@ -17,6 +17,8 @@ ) from tests_support.vcrpy_utils import get_vcr +from .conftest import safe_delete + gd_vcr = get_vcr() _default_jwk_id = "demoJwk" @@ -24,10 +26,16 @@ _fixtures_dir = _current_dir / "fixtures" / "organization" -def _default_organization_check(organization: CatalogOrganization): - assert organization.id == "default" - assert organization.attributes.name == "Default Organization" - assert organization.attributes.hostname == "localhost" +def _default_organization_check(organization: CatalogOrganization, test_config: dict | None = None): + if test_config and test_config.get("staging", False): + # On staging, org ID and hostname differ from local Docker + assert organization.id is not None + assert organization.attributes.name is not None + assert organization.attributes.hostname is not None + else: + assert organization.id == "default" + assert organization.attributes.name == "Default Organization" + assert organization.attributes.hostname == "localhost" def _default_jwk(jwk_id=_default_jwk_id, alg=None, kid=None): @@ -64,14 +72,14 @@ def _default_jwk(jwk_id=_default_jwk_id, alg=None, kid=None): def test_get_organization(test_config): sdk = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"]) organization = sdk.catalog_organization.get_organization() - _default_organization_check(organization) + _default_organization_check(organization, test_config) @gd_vcr.use_cassette(str(_fixtures_dir / "update_name.yaml")) def test_update_name(test_config): sdk = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"]) organization = sdk.catalog_organization.get_organization() - _default_organization_check(organization) + _default_organization_check(organization, test_config) default_name = organization.attributes.name new_name = "test_organization" @@ -82,9 +90,7 @@ def test_update_name(test_config): assert updated_organization.attributes.name == new_name assert updated_organization.attributes.hostname == organization.attributes.hostname finally: - sdk.catalog_organization.update_name(default_name) - organization = sdk.catalog_organization.get_organization() - _default_organization_check(organization) + safe_delete(sdk.catalog_organization.update_name, default_name) @gd_vcr.use_cassette(str(_fixtures_dir / "create_jwk.yaml")) @@ -97,8 +103,7 @@ def test_create_jwk(test_config): assert new_jwk.id == created_jwk.id assert new_jwk.attributes == created_jwk.attributes finally: - sdk.catalog_organization.delete_jwk("demoJwk") - assert len(sdk.catalog_organization.list_jwks()) == 0 + safe_delete(sdk.catalog_organization.delete_jwk, "demoJwk") @gd_vcr.use_cassette(str(_fixtures_dir / "update_jwk.yaml")) @@ -112,8 +117,7 @@ def test_update_jwk(test_config): updated_jwk = sdk.catalog_organization.get_jwk("demoJwk") assert update_jwk.attributes.content.alg == updated_jwk.attributes.content.alg finally: - sdk.catalog_organization.delete_jwk("demoJwk") - assert len(sdk.catalog_organization.list_jwks()) == 0 + safe_delete(sdk.catalog_organization.delete_jwk, "demoJwk") @gd_vcr.use_cassette(str(_fixtures_dir / "delete_jwk.yaml")) @@ -125,9 +129,9 @@ def test_delete_jwk(test_config): sdk.catalog_organization.delete_jwk(jwk.id) sdk.catalog_organization.get_jwk(jwk.id) except NotFoundException: - assert len(sdk.catalog_organization.list_jwks()) == 0 + pass # Expected: jwk was deleted successfully finally: - assert len(sdk.catalog_organization.list_jwks()) == 0 + safe_delete(sdk.catalog_organization.delete_jwk, jwk.id) @gd_vcr.use_cassette(str(_fixtures_dir / "list_jwk.yaml")) @@ -135,14 +139,15 @@ def test_list_jwk(test_config): sdk = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"]) jwk1 = _default_jwk(jwk_id="demoJwk1", kid="kid1") jwk2 = _default_jwk(jwk_id="demoJwk2", kid="kid2") + jwks_before = sdk.catalog_organization.list_jwks() try: sdk.catalog_organization.create_or_update_jwk(jwk1) sdk.catalog_organization.create_or_update_jwk(jwk2) - assert len(sdk.catalog_organization.list_jwks()) == 2 + jwks_after = sdk.catalog_organization.list_jwks() + assert len(jwks_after) == len(jwks_before) + 2 finally: - sdk.catalog_organization.delete_jwk(jwk1.id) - sdk.catalog_organization.delete_jwk(jwk2.id) - assert len(sdk.catalog_organization.list_jwks()) == 0 + safe_delete(sdk.catalog_organization.delete_jwk, jwk1.id) + safe_delete(sdk.catalog_organization.delete_jwk, jwk2.id) @gd_vcr.use_cassette(str(_fixtures_dir / "create_organization_setting.yaml")) @@ -160,8 +165,7 @@ def test_create_organization_setting(test_config): assert setting.attributes.type == setting_type assert setting.attributes.content == content finally: - sdk.catalog_organization.delete_organization_setting(setting_id) - assert len(sdk.catalog_organization.list_organization_settings()) == 0 + safe_delete(sdk.catalog_organization.delete_organization_setting, setting_id) @gd_vcr.use_cassette(str(_fixtures_dir / "list_organization_settings.yaml")) @@ -173,17 +177,17 @@ def test_list_organization_settings(test_config): new_setting_1 = CatalogOrganizationSetting.init(setting_id_1, "LOCALE", {"value": "fr-FR"}) new_setting_2 = CatalogOrganizationSetting.init(setting_id_2, "FORMAT_LOCALE", {"value": "en-GB"}) + settings_before = sdk.catalog_organization.list_organization_settings() try: sdk.catalog_organization.create_organization_setting(new_setting_1) sdk.catalog_organization.create_organization_setting(new_setting_2) organization_settings = sdk.catalog_organization.list_organization_settings() - assert len(organization_settings) == 2 + assert len(organization_settings) == len(settings_before) + 2 assert new_setting_1 in organization_settings assert new_setting_2 in organization_settings finally: - sdk.catalog_organization.delete_organization_setting(setting_id_1) - sdk.catalog_organization.delete_organization_setting(setting_id_2) - assert len(sdk.catalog_organization.list_organization_settings()) == 0 + safe_delete(sdk.catalog_organization.delete_organization_setting, setting_id_1) + safe_delete(sdk.catalog_organization.delete_organization_setting, setting_id_2) @gd_vcr.use_cassette(str(_fixtures_dir / "delete_organization_setting.yaml")) @@ -198,9 +202,9 @@ def test_delete_organization_setting(test_config): sdk.catalog_organization.delete_organization_setting(setting_id) sdk.catalog_organization.get_organization_setting(setting_id) except NotFoundException: - assert len(sdk.catalog_organization.list_organization_settings()) == 0 + pass # Expected: setting was deleted successfully finally: - assert len(sdk.catalog_organization.list_organization_settings()) == 0 + safe_delete(sdk.catalog_organization.delete_organization_setting, setting_id) @gd_vcr.use_cassette(str(_fixtures_dir / "update_organization_setting.yaml")) @@ -219,8 +223,7 @@ def test_update_organization_setting(test_config): assert setting.attributes.type == "LOCALE" assert setting.attributes.content == {"value": "en-GB"} finally: - sdk.catalog_organization.delete_organization_setting(setting_id) - assert len(sdk.catalog_organization.list_organization_settings()) == 0 + safe_delete(sdk.catalog_organization.delete_organization_setting, setting_id) @gd_vcr.use_cassette(str(_fixtures_dir / "create_csp_directive.yaml")) @@ -237,8 +240,7 @@ def test_create_csp_directive(test_config): assert csp_directive.id == directive_id assert csp_directive.attributes.sources == sources finally: - sdk.catalog_organization.delete_csp_directive(directive_id) - assert len(sdk.catalog_organization.list_csp_directives()) == 0 + safe_delete(sdk.catalog_organization.delete_csp_directive, directive_id) @gd_vcr.use_cassette(str(_fixtures_dir / "list_csp_directives.yaml")) @@ -250,17 +252,17 @@ def test_list_csp_directives(test_config): new_csp_directive_1 = CatalogCspDirective.init(directive_id_1, ["https://test.com"]) new_csp_directive_2 = CatalogCspDirective.init(directive_id_2, ["https://test2.com"]) + directives_before = sdk.catalog_organization.list_csp_directives() try: sdk.catalog_organization.create_csp_directive(new_csp_directive_1) sdk.catalog_organization.create_csp_directive(new_csp_directive_2) csp_directives = sdk.catalog_organization.list_csp_directives() - assert len(csp_directives) == 2 + assert len(csp_directives) == len(directives_before) + 2 assert new_csp_directive_1 in csp_directives assert new_csp_directive_2 in csp_directives finally: - sdk.catalog_organization.delete_csp_directive(directive_id_1) - sdk.catalog_organization.delete_csp_directive(directive_id_2) - assert len(sdk.catalog_organization.list_csp_directives()) == 0 + safe_delete(sdk.catalog_organization.delete_csp_directive, directive_id_1) + safe_delete(sdk.catalog_organization.delete_csp_directive, directive_id_2) @gd_vcr.use_cassette(str(_fixtures_dir / "delete_csp_directive.yaml")) @@ -275,9 +277,9 @@ def test_delete_csp_directive(test_config): sdk.catalog_organization.delete_csp_directive(directive_id) sdk.catalog_organization.get_csp_directive(directive_id) except NotFoundException: - assert len(sdk.catalog_organization.list_csp_directives()) == 0 + pass # Expected: directive was deleted successfully finally: - assert len(sdk.catalog_organization.list_csp_directives()) == 0 + safe_delete(sdk.catalog_organization.delete_csp_directive, directive_id) @gd_vcr.use_cassette(str(_fixtures_dir / "update_csp_directive.yaml")) @@ -295,14 +297,15 @@ def test_update_csp_directive(test_config): assert csp_directive.id == directive_id assert csp_directive.attributes.sources == ["https://test2.com"] finally: - sdk.catalog_organization.delete_csp_directive(directive_id) - assert len(sdk.catalog_organization.list_csp_directives()) == 0 + safe_delete(sdk.catalog_organization.delete_csp_directive, directive_id) @gd_vcr.use_cassette(str(_fixtures_dir / "update_allowed_origins.yaml")) def test_update_allowed_origins(test_config): sdk = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"]) + organization_before = sdk.catalog_organization.get_organization() + original_origins = organization_before.attributes.allowed_origins or [] allowed_origins = ["https://test.com"] try: @@ -310,39 +313,30 @@ def test_update_allowed_origins(test_config): organization = sdk.catalog_organization.get_organization() assert organization.attributes.allowed_origins == allowed_origins finally: - sdk.catalog_organization.update_allowed_origins([]) - organization = sdk.catalog_organization.get_organization() - assert organization.attributes.allowed_origins == [] + safe_delete(sdk.catalog_organization.update_allowed_origins, original_origins) @gd_vcr.use_cassette(str(_fixtures_dir / "layout_notification_channels.yaml")) -def test_layout_notification_channels(test_config): +def test_layout_notification_channels(test_config, snapshot_notification_channels): sdk = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"]) - ncs = sdk.catalog_organization.get_declarative_notification_channels() - assert len(ncs) == 0 - - try: - notification_channels_e = [ - CatalogDeclarativeNotificationChannel( - id="webhook", - name="Webhook", - destination=CatalogWebhook(url="https://webhook.site", token="123"), - custom_dashboard_url="https://dashboard.site", - allowed_recipients="CREATOR", - ), - ] - sdk.catalog_organization.put_declarative_notification_channels(notification_channels_e) - notification_channels_o = sdk.catalog_organization.get_declarative_notification_channels() - assert notification_channels_e[0].id == notification_channels_o[0].id - assert notification_channels_e[0].name == notification_channels_o[0].name - assert notification_channels_e[0].destination == notification_channels_o[0].destination - assert notification_channels_e[0].custom_dashboard_url == notification_channels_o[0].custom_dashboard_url - assert notification_channels_e[0].allowed_recipients == notification_channels_o[0].allowed_recipients - finally: - sdk.catalog_organization.put_declarative_notification_channels([]) - ncs = sdk.catalog_organization.get_declarative_notification_channels() - assert len(ncs) == 0 + notification_channels_e = [ + CatalogDeclarativeNotificationChannel( + id="webhook", + name="Webhook", + destination=CatalogWebhook(url="https://webhook.site", token="123"), + custom_dashboard_url="https://dashboard.site", + allowed_recipients="CREATOR", + ), + ] + sdk.catalog_organization.put_declarative_notification_channels(notification_channels_e) + notification_channels_o = sdk.catalog_organization.get_declarative_notification_channels() + assert notification_channels_e[0].id == notification_channels_o[0].id + assert notification_channels_e[0].name == notification_channels_o[0].name + assert notification_channels_e[0].destination == notification_channels_o[0].destination + assert notification_channels_e[0].custom_dashboard_url == notification_channels_o[0].custom_dashboard_url + assert notification_channels_e[0].allowed_recipients == notification_channels_o[0].allowed_recipients + # snapshot_notification_channels fixture restores original state in teardown @gd_vcr.use_cassette(str(_fixtures_dir / "get_llm_endpoint.yaml")) @@ -365,35 +359,35 @@ def test_get_llm_endpoint(test_config): assert not retrieved_endpoint.attributes.token # Token not returned for security finally: - # Clean up - sdk.catalog_organization.delete_llm_endpoint(test_id) + safe_delete(sdk.catalog_organization.delete_llm_endpoint, test_id) @gd_vcr.use_cassette(str(_fixtures_dir / "list_llm_endpoints.yaml")) def test_list_llm_endpoints(test_config): sdk = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"]) + test_id1 = "endpoint1" + test_id2 = "endpoint2" + try: - # Create test endpoints first - test_id1 = "endpoint1" test_title1 = "Test Endpoint 1" test_token1 = "secret-token-1" - test_id2 = "endpoint2" test_title2 = "Test Endpoint 2" test_token2 = "secret-token-2" - sdk.catalog_organization.create_llm_endpoint(id=test_id1, title=test_title1, token=test_token1) + endpoints_before = sdk.catalog_organization.list_llm_endpoints() + sdk.catalog_organization.create_llm_endpoint(id=test_id1, title=test_title1, token=test_token1) sdk.catalog_organization.create_llm_endpoint(id=test_id2, title=test_title2, token=test_token2) - # Get and verify the endpoints list endpoints = sdk.catalog_organization.list_llm_endpoints() assert isinstance(endpoints, list) - assert len(endpoints) == 2 + assert len(endpoints) == len(endpoints_before) + 2 assert all(isinstance(endpoint, CatalogLlmEndpoint) for endpoint in endpoints) - assert {endpoint.id for endpoint in endpoints} == {test_id1, test_id2} - assert {endpoint.attributes.title for endpoint in endpoints} == {test_title1, test_title2} + endpoint_ids = {endpoint.id for endpoint in endpoints} + assert test_id1 in endpoint_ids + assert test_id2 in endpoint_ids # Test with optional parameters filtered_endpoints = sdk.catalog_organization.list_llm_endpoints(filter="title=='Test Endpoint 1'", size=1) @@ -403,9 +397,8 @@ def test_list_llm_endpoints(test_config): assert filtered_endpoints[0].attributes.title == test_title1 finally: - # Clean up - sdk.catalog_organization.delete_llm_endpoint(test_id1) - sdk.catalog_organization.delete_llm_endpoint(test_id2) + safe_delete(sdk.catalog_organization.delete_llm_endpoint, test_id1) + safe_delete(sdk.catalog_organization.delete_llm_endpoint, test_id2) @gd_vcr.use_cassette(str(_fixtures_dir / "create_llm_endpoint.yaml")) @@ -456,9 +449,8 @@ def test_create_llm_endpoint(test_config): assert llm_endpoint_2.attributes.llm_organization == full_llm_org assert llm_endpoint_2.attributes.llm_model == full_llm_model finally: - # Cleanup - sdk.catalog_organization.delete_llm_endpoint(minimal_id) - sdk.catalog_organization.delete_llm_endpoint(full_id) + safe_delete(sdk.catalog_organization.delete_llm_endpoint, minimal_id) + safe_delete(sdk.catalog_organization.delete_llm_endpoint, full_id) @gd_vcr.use_cassette(str(_fixtures_dir / "update_llm_endpoint.yaml")) @@ -527,8 +519,7 @@ def test_update_llm_endpoint(test_config): assert llm_endpoint_3.attributes.llm_organization == full_llm_org assert llm_endpoint_3.attributes.llm_model == full_llm_model finally: - # Cleanup - sdk.catalog_organization.delete_llm_endpoint(initial_id) + safe_delete(sdk.catalog_organization.delete_llm_endpoint, initial_id) @gd_vcr.use_cassette(str(_fixtures_dir / "delete_llm_endpoint.yaml")) @@ -549,11 +540,7 @@ def test_delete_llm_endpoint(test_config): except NotFoundException: pass finally: - # Ensure cleanup - try: - sdk.catalog_organization.delete_llm_endpoint("endpoint1") - except NotFoundException: - pass + safe_delete(sdk.catalog_organization.delete_llm_endpoint, "endpoint1") # diff --git a/packages/gooddata-sdk/tests/catalog/test_catalog_permission.py b/packages/gooddata-sdk/tests/catalog/test_catalog_permission.py index 66381bb61..b6b3ce4a3 100644 --- a/packages/gooddata-sdk/tests/catalog/test_catalog_permission.py +++ b/packages/gooddata-sdk/tests/catalog/test_catalog_permission.py @@ -22,6 +22,8 @@ ) from tests_support.vcrpy_utils import get_vcr +from .conftest import safe_delete + gd_vcr = get_vcr() _current_dir = Path(__file__).parent.absolute() @@ -33,9 +35,6 @@ def _empty_permissions(sdk: GoodDataSdk, workspace_id: str) -> None: sdk.catalog_permission.put_declarative_permissions( workspace_id=workspace_id, declarative_workspace_permissions=empty_permissions_e ) - empty_permissions_o = sdk.catalog_permission.get_declarative_permissions(workspace_id=workspace_id) - assert empty_permissions_e == empty_permissions_o - assert empty_permissions_e.to_dict(camel_case=True) == empty_permissions_o.to_dict(camel_case=True) def _assert_default_permissions(catalog_declarative_permissions: CatalogDeclarativeWorkspacePermissions) -> None: @@ -68,11 +67,6 @@ def _default_organization_permissions(sdk: GoodDataSdk) -> None: sdk.catalog_permission.put_declarative_organization_permissions([default_catalog_organization_permission]) - catalog_permissions = sdk.catalog_permission.get_declarative_organization_permissions() - assert len(catalog_permissions) == 1 - _assert_organization_permissions_id(catalog_permissions) - assert set(org_permission.name for org_permission in catalog_permissions) == {"MANAGE"} - def _validation_helper(class_type, attribute_name: str): client_class = class_type.client_class() @@ -122,11 +116,6 @@ def _rollback_dashboard_permissions(sdk: GoodDataSdk) -> None: ), ], ) - # check that it was properly removed - dashboard_permissions = sdk.catalog_permission.list_dashboard_permissions("demo", "campaign") - assert len(dashboard_permissions.user_groups) == 0 - assert len(dashboard_permissions.users) == 0 - assert len(dashboard_permissions.rules) == 0 def test_single_workspace_permission_validation(test_config): @@ -154,7 +143,7 @@ def test_get_declarative_permissions(test_config): @gd_vcr.use_cassette(str(_fixtures_dir / "put_declarative_permissions.yaml")) -def test_put_declarative_permissions(test_config): +def test_put_declarative_permissions(test_config, snapshot_permissions): sdk = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"]) expected_json_path = _current_dir / "expected" / "declarative_workspace_permissions.json" workspace_id = test_config["workspace_with_parent"] @@ -174,7 +163,7 @@ def test_put_declarative_permissions(test_config): declarative_permissions_o = sdk.catalog_permission.get_declarative_permissions(workspace_id=workspace_id) _assert_default_permissions(declarative_permissions_o) finally: - _empty_permissions(sdk, workspace_id) + safe_delete(_empty_permissions, sdk, workspace_id) @gd_vcr.use_cassette(str(_fixtures_dir / "list_available_assignees.yaml")) @@ -190,11 +179,11 @@ def test_list_dashboard_permissions(test_config): try: _add_dashboard_permissions(sdk) finally: - _rollback_dashboard_permissions(sdk) + safe_delete(_rollback_dashboard_permissions, sdk) @gd_vcr.use_cassette(str(_fixtures_dir / "put_declarative_organization_permissions.yaml")) -def test_put_and_get_declarative_organization_permissions(test_config): +def test_put_and_get_declarative_organization_permissions(test_config, snapshot_org_permissions): expected_json_path = _current_dir / "expected" / "declarative_organization_permissions.json" sdk = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"]) @@ -216,11 +205,11 @@ def test_put_and_get_declarative_organization_permissions(test_config): "SELF_CREATE_TOKEN", } finally: - _default_organization_permissions(sdk) + safe_delete(_default_organization_permissions, sdk) @gd_vcr.use_cassette(str(_fixtures_dir / "manage_organization_permissions.yaml")) -def test_manage_organization_permissions(test_config): +def test_manage_organization_permissions(test_config, snapshot_org_permissions): sdk = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"]) # assign permissions to adminGroup @@ -241,7 +230,7 @@ def test_manage_organization_permissions(test_config): "SELF_CREATE_TOKEN", } finally: - _default_organization_permissions(sdk) + safe_delete(_default_organization_permissions, sdk) @gd_vcr.use_cassette(str(_fixtures_dir / "manage_dashboard_permissions_declarative_workspace.yaml")) @@ -251,4 +240,4 @@ def test_manage_dashboard_permissions_declarative_workspace(test_config): _add_dashboard_permissions(sdk) sdk.catalog_workspace.get_declarative_workspace(workspace_id="demo") finally: - _rollback_dashboard_permissions(sdk) + safe_delete(_rollback_dashboard_permissions, sdk) diff --git a/packages/gooddata-sdk/tests/catalog/test_catalog_user_service.py b/packages/gooddata-sdk/tests/catalog/test_catalog_user_service.py index 21ba01cd9..5e4f113e2 100644 --- a/packages/gooddata-sdk/tests/catalog/test_catalog_user_service.py +++ b/packages/gooddata-sdk/tests/catalog/test_catalog_user_service.py @@ -41,6 +41,8 @@ from gooddata_sdk.utils import recreate_directory from tests_support.vcrpy_utils import get_vcr +from .conftest import safe_delete + gd_vcr = get_vcr() _current_dir = Path(__file__).parent.absolute() @@ -54,8 +56,14 @@ def test_list_users(test_config): sdk = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"]) users = sdk.catalog_user.list_users() - assert len(users) == 3 - assert set(user.id for user in users) == {"demo2", "admin", "demo"} + user_ids = {user.id for user in users} + if test_config.get("staging", False): + assert len(users) >= 2 + assert "admin" in user_ids + assert test_config["test_user"] in user_ids + else: + assert len(users) >= 3 + assert {"demo2", "admin", "demo"}.issubset(user_ids) @gd_vcr.use_cassette(str(_fixtures_dir / "get_user.yaml")) @@ -76,8 +84,8 @@ def test_create_delete_user(test_config): authentication_id = f"{user_id}_auth_id" user_group_ids = [test_config["test_user_group"]] + initial_count = len(sdk.catalog_user.list_users()) try: - assert len(sdk.catalog_user.list_users()) == 3 user_e = CatalogUser.init( user_id=user_id, firstname=firstname, @@ -88,7 +96,7 @@ def test_create_delete_user(test_config): ) sdk.catalog_user.create_or_update_user(user_e) user = sdk.catalog_user.get_user(user_id) - assert len(sdk.catalog_user.list_users()) == 4 + assert len(sdk.catalog_user.list_users()) == initial_count + 1 assert user.id == user_id assert [i.id for i in user.user_groups] == user_group_ids assert user.attributes.firstname == firstname @@ -96,8 +104,7 @@ def test_create_delete_user(test_config): assert user.attributes.email == email assert user.attributes.authentication_id == authentication_id finally: - sdk.catalog_user.delete_user(user_id) - assert len(sdk.catalog_user.list_users()) == 3 + safe_delete(sdk.catalog_user.delete_user, user_id) @gd_vcr.use_cassette(str(_fixtures_dir / "update_user.yaml")) @@ -172,13 +179,7 @@ def test_update_user(test_config): assert set([i.id for i in updated_user.user_groups]) == set(new_user_group_ids) finally: - # Clean up: Delete temporary user (no cascade issues since it has no permissions) - try: - sdk.catalog_user.delete_user(temp_user_id) - except Exception: - pass # User may not exist if creation failed - # Verify we're back to original user count - assert len(sdk.catalog_user.list_users()) == initial_user_count + safe_delete(sdk.catalog_user.delete_user, temp_user_id) def _restore_demo2_permissions(sdk: GoodDataSdk, test_config: dict) -> None: @@ -226,14 +227,9 @@ def _restore_demo2_permissions(sdk: GoodDataSdk, test_config: dict) -> None: def test_list_user_groups(test_config): sdk = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"]) user_groups = sdk.catalog_user.list_user_groups() - assert len(user_groups) == 4 - assert set(user_group.id for user_group in user_groups) == { - "adminGroup", - "demoGroup", - "adminQA1Group", - "visitorsGroup", - } - assert set(user_group.name for user_group in user_groups) == {"demo group", "visitors", None} + assert len(user_groups) >= 4 + expected_ids = {"adminGroup", "demoGroup", "adminQA1Group", "visitorsGroup"} + assert expected_ids.issubset(set(user_group.id for user_group in user_groups)) @gd_vcr.use_cassette(str(_fixtures_dir / "get_user_group.yaml")) @@ -249,10 +245,8 @@ def test_create_delete_user_group(test_config): user_group_id = test_config["test_new_user_group"] user_group_parent_ids = [test_config["test_user_group"]] + initial_count = len(sdk.catalog_user.list_user_groups()) try: - current_user_groups = sdk.catalog_user.list_user_groups() - assert len(current_user_groups) == 4 - assert set(ug.name for ug in current_user_groups) == {"demo group", "visitors", None} user_group_e = CatalogUserGroup.init( user_group_id=user_group_id, user_group_name=user_group_id.upper(), @@ -260,13 +254,12 @@ def test_create_delete_user_group(test_config): ) sdk.catalog_user.create_or_update_user_group(user_group_e) user_group = sdk.catalog_user.get_user_group(user_group_id) - assert len(sdk.catalog_user.list_user_groups()) == 5 + assert len(sdk.catalog_user.list_user_groups()) == initial_count + 1 assert user_group.id == user_group_id assert user_group.name == user_group_id.upper() assert [p.id for p in user_group.relationships.parents.data] == user_group_parent_ids finally: - sdk.catalog_user.delete_user_group(user_group_id) - assert len(sdk.catalog_user.list_user_groups()) == 4 + safe_delete(sdk.catalog_user.delete_user_group, user_group_id) @gd_vcr.use_cassette(str(_fixtures_dir / "update_user_group.yaml")) @@ -276,7 +269,6 @@ def test_update_user_group(test_config): user_group = sdk.catalog_user.get_user_group(user_group_id) user_group_parent_ids = [] new_user_group_name = "test_update_user_group" - assert len(sdk.catalog_user.list_user_groups()) == 4 try: user_group_e = CatalogUserGroup.init( @@ -292,8 +284,7 @@ def test_update_user_group(test_config): assert len(updated_user_group.get_parents) == len(user_group_parent_ids) assert set(updated_user_group.get_parents) == set(user_group_parent_ids) finally: - sdk.catalog_user.create_or_update_user_group(user_group) - assert len(sdk.catalog_user.list_user_groups()) == 4 + safe_delete(sdk.catalog_user.create_or_update_user_group, user_group) # DECLARATIVE USERS @@ -307,7 +298,7 @@ def test_get_declarative_users(test_config): users = sdk.catalog_user.get_declarative_users() - _assert_users_default(users.users) + _assert_users_default(users.users, test_config) assert users.to_dict(camel_case=True) == layout_api.get_users_layout().to_dict(camel_case=True) @@ -318,7 +309,7 @@ def test_store_declarative_users(test_config): recreate_directory(path) users_e = sdk.catalog_user.get_declarative_users() - _assert_users_default(users_e.users) + _assert_users_default(users_e.users, test_config) sdk.catalog_user.store_declarative_users(path) users_o = sdk.catalog_user.load_declarative_users(path) @@ -328,38 +319,43 @@ def test_store_declarative_users(test_config): @gd_vcr.use_cassette(str(_fixtures_dir / "put_declarative_users.yaml")) -def test_put_declarative_users(test_config): +def test_put_declarative_users(test_config, snapshot_full_user_context): sdk = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"]) users_e = sdk.catalog_user.get_declarative_users() - _assert_users_default(users_e.users) + _assert_users_default(users_e.users, test_config) try: - _clear_users(sdk) + _clear_users(sdk, test_config) sdk.catalog_user.put_declarative_users(users_e) users_o = sdk.catalog_user.get_declarative_users() assert users_e == users_o assert users_e.to_dict(camel_case=True) == users_o.to_dict(camel_case=True) finally: - sdk.catalog_user.put_declarative_users(users_e) + safe_delete(sdk.catalog_user.put_declarative_users, users_e) @gd_vcr.use_cassette(str(_fixtures_dir / "load_and_put_declarative_users.yaml")) -def test_load_and_put_declarative_users(test_config): +def test_load_and_put_declarative_users(test_config, snapshot_full_user_context): sdk = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"]) path = _current_dir / "load" users_e = sdk.catalog_user.get_declarative_users() - _assert_users_default(users_e.users) + _assert_users_default(users_e.users, test_config) try: - _clear_users(sdk) + _clear_users(sdk, test_config) sdk.catalog_user.load_and_put_declarative_users(path) users_o = sdk.catalog_user.get_declarative_users() - assert set(user.id for user in users_e.users) == set(user.id for user in users_o.users) - assert [user.user_groups for user in users_e.users] == [user.user_groups for user in users_o.users] + expected_ids = {"admin", test_config["demo_user"], test_config["test_user"]} + actual_ids = set(user.id for user in users_o.users) + assert expected_ids.issubset(actual_ids), f"Expected users {expected_ids} not found in {actual_ids}" + # Verify user group assignments for the expected users + expected_groups = {u.id: u.user_groups for u in users_e.users if u.id in expected_ids} + actual_groups = {u.id: u.user_groups for u in users_o.users if u.id in expected_ids} + assert expected_groups == actual_groups finally: - sdk.catalog_user.put_declarative_users(users_e) + safe_delete(sdk.catalog_user.put_declarative_users, users_e) # DECLARATIVE USER GROUPS @@ -373,7 +369,7 @@ def test_get_declarative_user_groups(test_config): user_groups = sdk.catalog_user.get_declarative_user_groups() - _assert_user_groups_default(user_groups.user_groups) + _assert_user_groups_default(user_groups.user_groups, test_config) assert user_groups.to_dict(camel_case=True) == layout_api.get_user_groups_layout().to_dict(camel_case=True) @@ -384,7 +380,7 @@ def test_store_declarative_user_groups(test_config): recreate_directory(path) user_groups_e = sdk.catalog_user.get_declarative_user_groups() - _assert_user_groups_default(user_groups_e.user_groups) + _assert_user_groups_default(user_groups_e.user_groups, test_config) sdk.catalog_user.store_declarative_user_groups(path) user_groups_o = sdk.catalog_user.load_declarative_user_groups(path) @@ -394,58 +390,48 @@ def test_store_declarative_user_groups(test_config): @gd_vcr.use_cassette(str(_fixtures_dir / "put_declarative_user_groups.yaml")) -def test_put_declarative_user_groups(test_config): +def test_put_declarative_user_groups(test_config, snapshot_full_user_context): sdk = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"]) - user_groups_path = _current_dir / "expected" / "declarative_user_groups.json" user_groups_e = sdk.catalog_user.get_declarative_user_groups() users_e = sdk.catalog_user.get_declarative_users() - _assert_user_groups_default(user_groups_e.user_groups) - _assert_users_default(users_e.users) + _assert_user_groups_default(user_groups_e.user_groups, test_config) + _assert_users_default(users_e.users, test_config) try: - _clear_users(sdk) - _clear_user_groups(sdk) + _clear_users(sdk, test_config) + _clear_user_groups(sdk, test_config) sdk.catalog_user.put_declarative_user_groups(user_groups_e) user_groups_o = sdk.catalog_user.get_declarative_user_groups() assert user_groups_e == user_groups_o assert user_groups_e.to_dict(camel_case=True) == user_groups_o.to_dict(camel_case=True) finally: - with open(user_groups_path) as f: - data = json.load(f) - user_groups_o = CatalogDeclarativeUserGroups.from_dict(data, camel_case=True) - sdk.catalog_user.put_declarative_user_groups(user_groups_o) - - sdk.catalog_user.put_declarative_users(users_e) + safe_delete(sdk.catalog_user.put_declarative_user_groups, user_groups_e) + safe_delete(sdk.catalog_user.put_declarative_users, users_e) @gd_vcr.use_cassette(str(_fixtures_dir / "load_and_put_declarative_user_groups.yaml")) -def test_load_and_put_declarative_user_groups(test_config): +def test_load_and_put_declarative_user_groups(test_config, snapshot_full_user_context): sdk = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"]) path = _current_dir / "load" - expected_json_path = _current_dir / "expected" / "declarative_user_groups.json" users_e = sdk.catalog_user.get_declarative_users() user_groups_e = sdk.catalog_user.get_declarative_user_groups() - _assert_user_groups_default(user_groups_e.user_groups) - _assert_users_default(users_e.users) + _assert_user_groups_default(user_groups_e.user_groups, test_config) + _assert_users_default(users_e.users, test_config) try: - _clear_users(sdk) - _clear_user_groups(sdk) + _clear_users(sdk, test_config) + _clear_user_groups(sdk, test_config) sdk.catalog_user.load_and_put_declarative_user_groups(path) user_groups_o = sdk.catalog_user.get_declarative_user_groups() assert user_groups_e == user_groups_o assert user_groups_e.to_dict(camel_case=True) == user_groups_o.to_dict(camel_case=True) finally: - with open(expected_json_path) as f: - data = json.load(f) - user_groups_o = CatalogDeclarativeUserGroups.from_dict(data, camel_case=True) - sdk.catalog_user.put_declarative_user_groups(user_groups_o) - - sdk.catalog_user.put_declarative_users(users_e) + safe_delete(sdk.catalog_user.put_declarative_user_groups, user_groups_e) + safe_delete(sdk.catalog_user.put_declarative_users, users_e) # DECLARATIVE USERS AND USER GROUPS @@ -457,7 +443,7 @@ def test_get_declarative_users_user_groups(test_config): users_user_groups = sdk.catalog_user.get_declarative_users_user_groups() - _assert_users_user_groups_default(users_user_groups) + _assert_users_user_groups_default(users_user_groups, test_config) assert users_user_groups.to_dict(camel_case=True) == layout_api.get_users_user_groups_layout().to_dict( camel_case=True ) @@ -470,7 +456,7 @@ def test_store_declarative_users_user_groups(test_config): recreate_directory(path) users_user_groups_e = sdk.catalog_user.get_declarative_users_user_groups() - _assert_users_user_groups_default(users_user_groups_e) + _assert_users_user_groups_default(users_user_groups_e, test_config) sdk.catalog_user.store_declarative_users_user_groups(path) users_user_groups_o = sdk.catalog_user.load_declarative_users_user_groups(path) @@ -480,39 +466,39 @@ def test_store_declarative_users_user_groups(test_config): @gd_vcr.use_cassette(str(_fixtures_dir / "put_declarative_users_user_groups.yaml")) -def test_put_declarative_users_user_groups(test_config): +def test_put_declarative_users_user_groups(test_config, snapshot_full_user_context): sdk = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"]) users_user_groups_e = sdk.catalog_user.get_declarative_users_user_groups() - _assert_users_user_groups_default(users_user_groups_e) + _assert_users_user_groups_default(users_user_groups_e, test_config) try: - _clear_users(sdk) - _clear_user_groups(sdk) + _clear_users(sdk, test_config) + _clear_user_groups(sdk, test_config) sdk.catalog_user.put_declarative_users_user_groups(users_user_groups_e) users_user_groups_o = sdk.catalog_user.get_declarative_users_user_groups() assert users_user_groups_e == users_user_groups_o assert users_user_groups_e.to_dict(camel_case=True) == users_user_groups_o.to_dict(camel_case=True) finally: - sdk.catalog_user.put_declarative_users_user_groups(users_user_groups_e) + safe_delete(sdk.catalog_user.put_declarative_users_user_groups, users_user_groups_e) @gd_vcr.use_cassette(str(_fixtures_dir / "load_and_put_declarative_users_user_groups.yaml")) -def test_load_and_put_declarative_users_user_groups(test_config): +def test_load_and_put_declarative_users_user_groups(test_config, snapshot_full_user_context): sdk = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"]) path = _current_dir / "load" users_user_groups_e = sdk.catalog_user.get_declarative_users_user_groups() - _assert_users_user_groups_default(users_user_groups_e) + _assert_users_user_groups_default(users_user_groups_e, test_config) try: - _clear_users(sdk) - _clear_user_groups(sdk) + _clear_users(sdk, test_config) + _clear_user_groups(sdk, test_config) sdk.catalog_user.load_and_put_declarative_users_user_groups(path) users_user_groups_o = sdk.catalog_user.get_declarative_users_user_groups() - _assert_users_user_groups_default(users_user_groups_o) + _assert_users_user_groups_default(users_user_groups_o, test_config) finally: - sdk.catalog_user.put_declarative_users_user_groups(users_user_groups_e) + safe_delete(sdk.catalog_user.put_declarative_users_user_groups, users_user_groups_e) @gd_vcr.use_cassette(str(_fixtures_dir / "test_user_add_user_group.yaml")) @@ -666,7 +652,7 @@ def test_manage_user_permissions(test_config): assert updated_permissions.workspaces[0].permissions == ["MANAGE"] assert updated_permissions.workspaces[0].hierarchy_permissions == ["MANAGE"] finally: - sdk.catalog_user.manage_user_permissions(user_id, origin_permissions) + safe_delete(sdk.catalog_user.manage_user_permissions, user_id, origin_permissions) @pytest.mark.dependency(name="test_get_user_group_permissions") @@ -722,7 +708,7 @@ def test_manage_user_group_permissions(test_config): assert updated_permissions.workspaces[0].permissions == ["VIEW"] assert updated_permissions.workspaces[0].hierarchy_permissions == ["ANALYZE"] finally: - sdk.catalog_user.manage_user_group_permissions(group_id, origin_permissions) + safe_delete(sdk.catalog_user.manage_user_group_permissions, group_id, origin_permissions) @gd_vcr.use_cassette(str(_fixtures_dir / "test_assign_permissions_bulk.yaml")) @@ -753,8 +739,8 @@ def test_assign_permissions_bulk(test_config): assert new_group_permissions.data_sources == new_user_permissions.data_sources finally: - sdk.catalog_user.manage_user_permissions(user_id, origin_permissions_user) - sdk.catalog_user.manage_user_group_permissions(group_id, origin_permissions_user_group) + safe_delete(sdk.catalog_user.manage_user_permissions, user_id, origin_permissions_user) + safe_delete(sdk.catalog_user.manage_user_group_permissions, group_id, origin_permissions_user_group) @gd_vcr.use_cassette(str(_fixtures_dir / "test_revoke_permissions_bulk.yaml")) @@ -775,14 +761,16 @@ def test_revoke_permissions_bulk(test_config): assert len(permissions.workspaces) == 0 assert len(permissions.data_sources) == 0 finally: - sdk.catalog_user.manage_user_permissions(user_id, origin_permissions) + safe_delete(sdk.catalog_user.manage_user_permissions, user_id, origin_permissions) @gd_vcr.use_cassette(str(_fixtures_dir / "test_api_tokens.yaml")) def test_api_tokens(test_config): sdk = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"]) - tokens = sdk.catalog_user.list_user_api_tokens(test_config["demo_user"]) - assert len(tokens) == 0 + initial_tokens = sdk.catalog_user.list_user_api_tokens(test_config["demo_user"]) + initial_count = len(initial_tokens) + if not test_config.get("staging", False): + assert initial_count == 0 token_id = "test_token" try: @@ -795,81 +783,89 @@ def test_api_tokens(test_config): assert token.bearer_token is None tokens = sdk.catalog_user.list_user_api_tokens(test_config["demo_user"]) - assert len(tokens) == 1 - assert tokens[0].id == token_id - assert tokens[0].bearer_token is None + assert len(tokens) == initial_count + 1 + assert any(t.id == token_id for t in tokens) finally: - sdk.catalog_user.delete_user_api_token(test_config["demo_user"], token_id) - tokens = sdk.catalog_user.list_user_api_tokens(test_config["demo_user"]) - assert len(tokens) == 0 + safe_delete(sdk.catalog_user.delete_user_api_token, test_config["demo_user"], token_id) # Help functions -def _assert_users_default(users: list[CatalogDeclarativeUser]): - assert len(users) == 3 - assert [user.id for user in users] == ["admin", "demo", "demo2"] - - -def _assert_user_groups_default(user_groups: list[CatalogDeclarativeUserGroup]): - assert len(user_groups) == 4 - assert set(user_group.id for user_group in user_groups) == { - "adminGroup", - "demoGroup", - "adminQA1Group", - "visitorsGroup", - } - assert set(user_group.name for user_group in user_groups) == {"demo group", "visitors", None} - - -def _assert_users_user_groups_default(users_user_groups: CatalogDeclarativeUsersUserGroups): - _assert_users_default(users_user_groups.users) - _assert_user_groups_default(users_user_groups.user_groups) - - -def _clear_users(sdk: GoodDataSdk) -> None: - """Remove all users except admin, demo, and demo2. - - WARNING: This function intentionally preserves demo2 because: - 1. Deleting demo2 cascade-deletes data source permissions referencing it - 2. Deleting demo2 cascade-deletes workspace permissions referencing it - 3. These cascade deletes break subsequent permission tests (test_get_user_permissions, etc.) - - If you need to delete demo2, ensure you call _restore_demo2_permissions() afterward - to restore the expected permission state. +def _assert_users_default(users: list[CatalogDeclarativeUser], test_config: dict | None = None): + if test_config and test_config.get("staging", False): + # On staging with DEX, user IDs are dynamic (e.g. python.demo.). + # Check that expected users exist by config values rather than hardcoded IDs. + user_ids = {user.id for user in users} + assert len(users) >= 2, f"Expected at least 2 users, got {len(users)}: {user_ids}" + assert "admin" in user_ids, f"'admin' user missing, got: {user_ids}" + assert test_config["test_user"] in user_ids, f"test_user '{test_config['test_user']}' missing, got: {user_ids}" + else: + assert len(users) == 3 + assert [user.id for user in users] == ["admin", "demo", "demo2"] + + +def _assert_user_groups_default(user_groups: list[CatalogDeclarativeUserGroup], test_config: dict | None = None): + if test_config and test_config.get("staging", False): + group_ids = {ug.id for ug in user_groups} + assert len(user_groups) >= 4, f"Expected at least 4 user groups, got {len(user_groups)}: {group_ids}" + for expected in ["adminGroup", "demoGroup", "adminQA1Group", "visitorsGroup"]: + assert expected in group_ids, f"'{expected}' group missing, got: {group_ids}" + else: + assert len(user_groups) == 4 + assert set(user_group.id for user_group in user_groups) == { + "adminGroup", + "demoGroup", + "adminQA1Group", + "visitorsGroup", + } + assert set(user_group.name for user_group in user_groups) == {"demo group", "visitors", None} + + +def _assert_users_user_groups_default( + users_user_groups: CatalogDeclarativeUsersUserGroups, test_config: dict | None = None +): + _assert_users_default(users_user_groups.users, test_config) + _assert_user_groups_default(users_user_groups.user_groups, test_config) + + +def _clear_users(sdk: GoodDataSdk, test_config: dict) -> None: + """Remove all users except admin and those referenced by test_config. + + WARNING: This function intentionally preserves demo_user and test_user because: + 1. Deleting them cascade-deletes data source permissions referencing them + 2. Deleting them cascade-deletes workspace permissions referencing them + 3. These cascade deletes break subsequent permission tests Protected users: - admin: System administrator - - demo: Default demo user - - demo2: Test user with permission references (test_config["test_user"]) + - test_config["demo_user"]: Default demo user + - test_config["test_user"]: Test user with permission references """ + protected = {"admin", test_config["demo_user"], test_config["test_user"]} users = sdk.catalog_user.list_users() for user in users: - if user.id not in ["admin", "demo", "demo2"]: + if user.id not in protected: sdk.catalog_user.delete_user(user.id) -def _clear_user_groups(sdk: GoodDataSdk) -> None: - """Remove all user groups except adminGroup and demoGroup. - - WARNING: This function intentionally preserves demoGroup because: - 1. Deleting demoGroup cascade-deletes data source permissions referencing it - 2. Deleting demoGroup cascade-deletes workspace permissions referencing it - 3. These cascade deletes break subsequent permission tests (test_get_user_group_permissions, etc.) +def _clear_user_groups(sdk: GoodDataSdk, test_config: dict) -> None: + """Remove all user groups except those referenced by test_config. - If you need to delete demoGroup, ensure you call _restore_demo2_permissions() afterward - to restore the expected permission state. + WARNING: This function intentionally preserves admin and test user groups because: + 1. Deleting them cascade-deletes data source permissions referencing them + 2. Deleting them cascade-deletes workspace permissions referencing them + 3. These cascade deletes break subsequent permission tests Protected user groups: - - adminGroup: Admin group - - demoGroup: Test user group with permission references (test_config["test_user_group"]) + - test_config["admin_user_group"]: Admin group + - test_config["test_user_group"]: Test user group with permission references """ sdk.catalog_user.put_declarative_user_groups( CatalogDeclarativeUserGroups( user_groups=[ - CatalogDeclarativeUserGroup(id="adminGroup"), - CatalogDeclarativeUserGroup(id="demoGroup"), + CatalogDeclarativeUserGroup(id=test_config["admin_user_group"]), + CatalogDeclarativeUserGroup(id=test_config["test_user_group"]), ] ) ) diff --git a/packages/gooddata-sdk/tests/catalog/test_catalog_workspace.py b/packages/gooddata-sdk/tests/catalog/test_catalog_workspace.py index d0eff5401..b5323de38 100644 --- a/packages/gooddata-sdk/tests/catalog/test_catalog_workspace.py +++ b/packages/gooddata-sdk/tests/catalog/test_catalog_workspace.py @@ -39,6 +39,8 @@ from tests.catalog.utils import _refresh_workspaces +from .conftest import safe_delete + gd_vcr = get_vcr() _current_dir = Path(__file__).parent.absolute() @@ -108,7 +110,7 @@ def test_load_and_put_declarative_workspaces(test_config): assert deep_eq(workspaces_e, workspaces_o) assert deep_eq(workspaces_e.to_dict(camel_case=True), workspaces_o.to_dict(camel_case=True)) finally: - _refresh_workspaces(sdk) + safe_delete(_refresh_workspaces, sdk) @gd_vcr.use_cassette(str(_fixtures_dir / "demo_store_declarative_workspaces.yaml")) @@ -138,7 +140,7 @@ def test_put_declarative_workspaces(test_config): assert workspaces_e == workspaces_o assert workspaces_e.to_dict(camel_case=True) == workspaces_o.to_dict(camel_case=True) finally: - _refresh_workspaces(sdk) + safe_delete(_refresh_workspaces, sdk) @gd_vcr.use_cassette(str(_fixtures_dir / "demo_get_declarative_workspaces_snake_case.yaml")) @@ -180,9 +182,12 @@ def test_declarative_workspaces(test_config): workspaces_o = sdk.catalog_workspace.get_declarative_workspaces(exclude=["ACTIVITY_INFO"]) - assert len(workspaces_o.workspaces) == 3 - assert len(workspaces_o.workspace_data_filters) == 2 - assert [workspace.id for workspace in workspaces_o.workspaces] == ["demo", "demo_west", "demo_west_california"] + assert len(workspaces_o.workspaces) >= 3 + assert len(workspaces_o.workspace_data_filters) >= 2 + workspace_ids = [workspace.id for workspace in workspaces_o.workspaces] + assert "demo" in workspace_ids + assert "demo_west" in workspace_ids + assert "demo_west_california" in workspace_ids assert workspaces_o.to_dict(camel_case=True) == layout_api.get_workspaces_layout(exclude=["ACTIVITY_INFO"]).to_dict( camel_case=True ) @@ -197,7 +202,7 @@ def test_update_workspace_invalid(test_config): workspace = sdk.catalog_workspace.get_workspace(test_config["workspace_with_parent"]) workspaces = sdk.catalog_workspace.list_workspaces() - assert len(workspaces) == 3 + initial_count = len(workspaces) assert workspace.id in [w.id for w in workspaces] assert workspace_new_parent not in [w.id for w in workspaces] assert workspace.parent_id is not None @@ -208,7 +213,7 @@ def test_update_workspace_invalid(test_config): # Update workspace parent is not allowed. workspaces = sdk.catalog_workspace.list_workspaces() workspace_o = sdk.catalog_workspace.get_workspace(workspace.id) - assert len(workspaces) == 3 + assert len(workspaces) == initial_count assert workspace == workspace_o @@ -224,7 +229,7 @@ def test_update_workspace_valid(test_config): new_workspace = CatalogWorkspace(workspace.id, workspace_new_name, workspace.parent_id) workspaces = sdk.catalog_workspace.list_workspaces() - assert len(workspaces) == 3 + initial_count = len(workspaces) assert workspace.id in [w.id for w in workspaces] assert workspace.parent_id is not None @@ -233,10 +238,10 @@ def test_update_workspace_valid(test_config): sdk.catalog_workspace.create_or_update(new_workspace) workspaces = sdk.catalog_workspace.list_workspaces() workspace_o = sdk.catalog_workspace.get_workspace(workspace.id) - assert len(workspaces) == 3 + assert len(workspaces) == initial_count assert workspace_o == new_workspace finally: - _refresh_workspaces(sdk) + safe_delete(_refresh_workspaces, sdk) @gd_vcr.use_cassette(str(_fixtures_dir / "demo_delete_workspace.yaml")) @@ -245,16 +250,16 @@ def test_delete_workspace(test_config): workspace_id = "demo_west_california" workspaces = sdk.catalog_workspace.list_workspaces() - assert len(workspaces) == 3 + initial_count = len(workspaces) assert workspace_id in [w.id for w in workspaces] try: sdk.catalog_workspace.delete_workspace(workspace_id) workspaces = sdk.catalog_workspace.list_workspaces() - assert len(workspaces) == 2 + assert len(workspaces) == initial_count - 1 assert workspace_id not in [w.id for w in workspaces] finally: - _refresh_workspaces(sdk) + safe_delete(_refresh_workspaces, sdk) @gd_vcr.use_cassette(str(_fixtures_dir / "demo_delete_non_existing_workspace.yaml")) @@ -263,7 +268,7 @@ def test_delete_non_existing_workspace(test_config): workspace_id = "non_existing_workspace" workspaces = sdk.catalog_workspace.list_workspaces() - assert len(workspaces) == 3 + initial_count = len(workspaces) assert workspace_id not in [w.id for w in workspaces] try: @@ -271,21 +276,21 @@ def test_delete_non_existing_workspace(test_config): except ValueError: # Trying to delete not existing workspace should not be executed and an exception should be raised. workspaces = sdk.catalog_workspace.list_workspaces() - assert len(workspaces) == 3 + assert len(workspaces) == initial_count @gd_vcr.use_cassette(str(_fixtures_dir / "demo_delete_parent_workspace.yaml")) def test_delete_parent_workspace(test_config): sdk = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"]) workspaces = sdk.catalog_workspace.list_workspaces() - assert len(workspaces) == 3 + initial_count = len(workspaces) try: sdk.catalog_workspace.delete_workspace(test_config["workspace"]) except ValueError: # Delete of workspace, which has children should not be executed and an exception should be raised. workspaces = sdk.catalog_workspace.list_workspaces() - assert len(workspaces) == 3 + assert len(workspaces) == initial_count @gd_vcr.use_cassette(str(_fixtures_dir / "demo_create_workspace.yaml")) @@ -298,17 +303,17 @@ def test_create_workspace(test_config): workspace = CatalogWorkspace(workspace_id, workspace_name, workspace_parent) workspaces = sdk.catalog_workspace.list_workspaces() - assert len(workspaces) == 3 + initial_count = len(workspaces) assert workspace_id not in [w.id for w in workspaces] try: sdk.catalog_workspace.create_or_update(workspace) workspaces = sdk.catalog_workspace.list_workspaces() workspace_o = sdk.catalog_workspace.get_workspace(workspace_id) - assert len(workspaces) == 4 + assert len(workspaces) == initial_count + 1 assert workspace_o == workspace finally: - _refresh_workspaces(sdk) + safe_delete(_refresh_workspaces, sdk) @gd_vcr.use_cassette(str(_fixtures_dir / "demo_get_workspace.yaml")) @@ -336,19 +341,19 @@ def test_workspace_list(test_config): parents = [None, "demo", "demo_west"] workspaces = sdk.catalog_workspace.list_workspaces() - assert len(workspaces) == 3 + assert len(workspaces) >= 3 workspaces_id = [w.id for w in workspaces] - workspaces_id.sort() - assert ids == workspaces_id + for expected_id in ids: + assert expected_id in workspaces_id workspaces_name = [w.name for w in workspaces] - workspaces_name.sort() - assert names == workspaces_name + for expected_name in names: + assert expected_name in workspaces_name workspaces_parent = {w.id: w.parent_id for w in workspaces} - workspaces_parent_l = [workspaces_parent[workspace_id] for workspace_id in workspaces_id] - assert parents == workspaces_parent_l + for ws_id, expected_parent in zip(ids, parents): + assert workspaces_parent[ws_id] == expected_parent @gd_vcr.use_cassette(str(_fixtures_dir / "demo_get_declarative_workspace_data_filters.yaml")) @@ -360,11 +365,10 @@ def test_get_declarative_workspace_data_filters(test_config): declarative_workspace_data_filters = sdk.catalog_workspace.get_declarative_workspace_data_filters() workspace_data_filters = declarative_workspace_data_filters.workspace_data_filters - assert len(workspace_data_filters) == 2 - assert set(workspace_data_filter.id for workspace_data_filter in workspace_data_filters) == { - "wdf__region", - "wdf__state", - } + assert len(workspace_data_filters) >= 2 + wdf_ids = {workspace_data_filter.id for workspace_data_filter in workspace_data_filters} + assert "wdf__region" in wdf_ids + assert "wdf__state" in wdf_ids assert declarative_workspace_data_filters.to_dict( camel_case=True @@ -401,7 +405,7 @@ def test_load_and_put_declarative_workspace_data_filters(test_config): assert workspace_data_filters_e == workspace_data_filters_o assert workspace_data_filters_e.to_dict(camel_case=True) == workspace_data_filters_o.to_dict(camel_case=True) finally: - _refresh_workspaces(sdk) + safe_delete(_refresh_workspaces, sdk) @gd_vcr.use_cassette(str(_fixtures_dir / "demo_put_declarative_workspace_data_filters.yaml")) @@ -419,7 +423,7 @@ def test_put_declarative_workspace_data_filters(test_config): camel_case=True ) == declarative_workspace_data_filters_o.to_dict(camel_case=True) finally: - _refresh_workspaces(sdk) + safe_delete(_refresh_workspaces, sdk) @gd_vcr.use_cassette(str(_fixtures_dir / "user_data_filters_life_cycle.yaml")) @@ -457,7 +461,7 @@ def test_user_data_filters_life_cycle(test_config): _are_user_data_filters_empty(sdk, test_config["workspace"]) finally: - _refresh_workspaces(sdk) + safe_delete(_refresh_workspaces, sdk) @gd_vcr.use_cassette(str(_fixtures_dir / "user_data_filters_for_user_group.yaml")) @@ -495,7 +499,7 @@ def test_user_data_filters_for_user_group(test_config): _are_user_data_filters_empty(sdk, test_config["workspace"]) finally: - _refresh_workspaces(sdk) + safe_delete(_refresh_workspaces, sdk) @gd_vcr.use_cassette(str(_fixtures_dir / "demo_get_declarative_user_data_filters.yaml")) @@ -545,7 +549,7 @@ def test_load_and_put_declarative_user_data_filters(test_config): assert user_data_filters_e == user_data_filters_o assert user_data_filters_e.to_dict(camel_case=True) == user_data_filters_o.to_dict(camel_case=True) finally: - _refresh_workspaces(sdk) + safe_delete(_refresh_workspaces, sdk) @gd_vcr.use_cassette(str(_fixtures_dir / "demo_put_declarative_user_data_filters.yaml")) @@ -558,7 +562,7 @@ def test_put_declarative_user_data_filters(test_config): id="user_data_filter", title="youwillnotsee", maql="FALSE", - user=CatalogUserIdentifier(id="demo", type="user"), + user=CatalogUserIdentifier(id=test_config["demo_user"], type="user"), ) ] ) @@ -570,7 +574,7 @@ def test_put_declarative_user_data_filters(test_config): assert user_data_filters_e == user_data_filters_o assert user_data_filters_e.to_dict() == user_data_filters_o.to_dict() finally: - _refresh_workspaces(sdk) + safe_delete(_refresh_workspaces, sdk) @gd_vcr.use_cassette(str(_fixtures_dir / "demo_get_declarative_workspace.yaml")) @@ -618,7 +622,7 @@ def test_put_declarative_workspace(test_config): assert deep_eq(workspace_e, workspace_o) assert deep_eq(workspace_e.to_dict(), workspace_o.to_dict()) finally: - _refresh_workspaces(sdk) + safe_delete(_refresh_workspaces, sdk) @gd_vcr.use_cassette(str(_fixtures_dir / "demo_store_declarative_workspace.yaml")) @@ -661,7 +665,7 @@ def test_load_and_put_declarative_workspace(test_config): assert deep_eq(workspace_e, workspace_o) assert deep_eq(workspace_e.to_dict(camel_case=True), workspace_o.to_dict(camel_case=True)) finally: - _refresh_workspaces(sdk) + safe_delete(_refresh_workspaces, sdk) def create_second_data_source(sdk: GoodDataSdk, ds_id: str) -> None: @@ -722,8 +726,8 @@ def test_clone_workspace(test_config): source_ws_id, data_source_mapping=data_source_mapping, upper_case=True, overwrite_existing=True ) finally: - _refresh_workspaces(sdk) - delete_data_source(sdk, test_config["data_source2"]) + safe_delete(_refresh_workspaces, sdk) + safe_delete(delete_data_source, sdk, test_config["data_source2"]) def _translate_batch(to_translate: list[str]) -> list[str]: @@ -771,7 +775,7 @@ def test_translate_workspace(test_config): layout_root_path=path_to_layouts, ) finally: - _refresh_workspaces(sdk) + safe_delete(_refresh_workspaces, sdk) @gd_vcr.use_cassette(str(_fixtures_dir / "create_workspace_setting.yaml")) @@ -787,8 +791,7 @@ def test_create_workspace_setting(test_config): setting_o = sdk.catalog_workspace.get_workspace_setting(test_config["workspace"], setting_id) assert setting_o == setting finally: - sdk.catalog_workspace.delete_workspace_setting(test_config["workspace"], setting_id) - assert len(sdk.catalog_workspace.list_workspace_settings(test_config["workspace"])) == 0 + safe_delete(sdk.catalog_workspace.delete_workspace_setting, test_config["workspace"], setting_id) @gd_vcr.use_cassette(str(_fixtures_dir / "list_workspace_settings.yaml")) @@ -813,9 +816,8 @@ def test_list_workspace_settings(test_config): assert new_setting_1 in workspace_settings assert new_setting_2 in workspace_settings finally: - sdk.catalog_workspace.delete_workspace_setting(test_config["workspace"], setting_id_1) - sdk.catalog_workspace.delete_workspace_setting(test_config["workspace"], setting_id_2) - assert len(sdk.catalog_workspace.list_workspace_settings(test_config["workspace"])) == 0 + safe_delete(sdk.catalog_workspace.delete_workspace_setting, test_config["workspace"], setting_id_1) + safe_delete(sdk.catalog_workspace.delete_workspace_setting, test_config["workspace"], setting_id_2) @gd_vcr.use_cassette(str(_fixtures_dir / "delete_workspace_setting.yaml")) @@ -834,8 +836,7 @@ def test_delete_workspace_setting(test_config): settings = sdk.catalog_workspace.list_workspace_settings(test_config["workspace"]) assert len(settings) == 0 finally: - sdk.catalog_workspace.delete_workspace_setting(test_config["workspace"], setting_id) - assert len(sdk.catalog_workspace.list_workspace_settings(test_config["workspace"])) == 0 + safe_delete(sdk.catalog_workspace.delete_workspace_setting, test_config["workspace"], setting_id) @gd_vcr.use_cassette(str(_fixtures_dir / "update_workspace_setting.yaml")) @@ -856,8 +857,7 @@ def test_update_workspace_setting(test_config): setting_o = sdk.catalog_workspace.get_workspace_setting(test_config["workspace"], setting_id) assert setting_o == setting finally: - sdk.catalog_workspace.delete_workspace_setting(test_config["workspace"], setting_id) - assert len(sdk.catalog_workspace.list_workspace_settings(test_config["workspace"])) == 0 + safe_delete(sdk.catalog_workspace.delete_workspace_setting, test_config["workspace"], setting_id) @gd_vcr.use_cassette(str(_fixtures_dir / "get_metadata_localization.yaml")) @@ -968,10 +968,8 @@ def test_layout_automations(test_config): automations_o = sdk.catalog_workspace.get_declarative_automations(workspace_id) assert automations_expected == automations_o finally: - sdk.catalog_workspace.put_declarative_automations(workspace_id, []) - automations = sdk.catalog_workspace.get_declarative_automations(workspace_id) - assert len(automations) == 0 - sdk.catalog_organization.put_declarative_notification_channels([]) + safe_delete(sdk.catalog_workspace.put_declarative_automations, workspace_id, []) + safe_delete(sdk.catalog_organization.put_declarative_notification_channels, []) @gd_vcr.use_cassette(str(_fixtures_dir / "layout_filter_views.yaml")) @@ -1025,7 +1023,7 @@ def test_layout_filter_views(test_config): is_default=True, description="Filter View", tags=["tag1", "tag2"], - user=CatalogUserIdentifier(id="demo", type="user"), + user=CatalogUserIdentifier(id=test_config["demo_user"], type="user"), analytical_dashboard=CatalogDeclarativeAnalyticalDashboardIdentifier( id="campaign", type="analyticalDashboard" ), @@ -1036,6 +1034,4 @@ def test_layout_filter_views(test_config): filter_views_o = sdk.catalog_workspace.get_declarative_filter_views(workspace_id) assert filter_views_expected == filter_views_o finally: - sdk.catalog_workspace.put_declarative_filter_views(workspace_id, []) - filter_views = sdk.catalog_workspace.get_declarative_filter_views(workspace_id) - assert len(filter_views) == 0 + safe_delete(sdk.catalog_workspace.put_declarative_filter_views, workspace_id, []) diff --git a/packages/gooddata-sdk/tests/catalog/test_catalog_workspace_content.py b/packages/gooddata-sdk/tests/catalog/test_catalog_workspace_content.py index a3dbeec6c..312088e9f 100644 --- a/packages/gooddata-sdk/tests/catalog/test_catalog_workspace_content.py +++ b/packages/gooddata-sdk/tests/catalog/test_catalog_workspace_content.py @@ -29,6 +29,7 @@ from tests_support.compare_utils import deep_eq from tests_support.vcrpy_utils import get_vcr +from tests.catalog.conftest import safe_delete from tests.catalog.utils import _refresh_workspaces gd_vcr = get_vcr() @@ -114,7 +115,7 @@ def test_load_and_put_declarative_ldm(test_config): assert deep_eq(ldm_e, ldm_o) assert deep_eq(ldm_e.to_api().to_dict(), ldm_o.to_api().to_dict()) finally: - _refresh_workspaces(sdk) + safe_delete(_refresh_workspaces, sdk) @gd_vcr.use_cassette(str(_fixtures_dir / "demo_load_and_modify_ds_and_put_declarative_ldm.yaml")) @@ -149,7 +150,7 @@ def test_load_and_modify_ds_and_put_declarative_ldm(test_config): ds_o = list(set([d.data_source_table_id.data_source_id for d in ldm_o.ldm.datasets if d.data_source_table_id])) assert ds_o == [test_config["data_source"]] finally: - _refresh_workspaces(sdk) + safe_delete(_refresh_workspaces, sdk) @gd_vcr.use_cassette(str(_fixtures_dir / "demo_load_ldm_and_modify_tables_columns_case.yaml")) @@ -218,7 +219,7 @@ def test_load_and_put_declarative_analytics_model(test_config): assert deep_eq(analytics_model_e, analytics_model_o) assert deep_eq(analytics_model_e.to_api().to_dict(), analytics_model_o.to_api().to_dict()) finally: - _refresh_workspaces(sdk) + safe_delete(_refresh_workspaces, sdk) @gd_vcr.use_cassette(str(_fixtures_dir / "demo_put_declarative_analytics_model.yaml")) @@ -235,7 +236,7 @@ def test_put_declarative_analytics_model(test_config): assert deep_eq(analytics_model_e, analytics_model_o) assert deep_eq(analytics_model_e.to_api().to_dict(), analytics_model_o.to_api().to_dict()) finally: - _refresh_workspaces(sdk) + safe_delete(_refresh_workspaces, sdk) @gd_vcr.use_cassette(str(_fixtures_dir / "demo_put_declarative_ldm.yaml")) @@ -254,7 +255,7 @@ def test_put_declarative_ldm(test_config): assert deep_eq(ldm_e, ldm_o) assert deep_eq(ldm_e.to_api().to_dict(), ldm_o.to_api().to_dict()) finally: - _refresh_workspaces(sdk) + safe_delete(_refresh_workspaces, sdk) @gd_vcr.use_cassette(str(_fixtures_dir / "demo_get_declarative_analytics_model.yaml")) @@ -477,7 +478,7 @@ def test_explicit_workspace_data_filter(test_config): ) assert len(dataset.workspace_data_filter_references) == 1 finally: - _refresh_workspaces(sdk) + safe_delete(_refresh_workspaces, sdk) @gd_vcr.use_cassette(str(_fixtures_dir / "export_definition_analytics_layout.yaml")) @@ -500,4 +501,4 @@ def test_export_definition_analytics_layout(test_config): ) assert deep_eq(analytics_o.analytics.export_definitions, analytics_e.analytics.export_definitions) finally: - _refresh_workspaces(sdk) + safe_delete(_refresh_workspaces, sdk) diff --git a/packages/gooddata-sdk/tests/conftest.py b/packages/gooddata-sdk/tests/conftest.py index d030cd203..7ebfc39ed 100644 --- a/packages/gooddata-sdk/tests/conftest.py +++ b/packages/gooddata-sdk/tests/conftest.py @@ -1,4 +1,5 @@ # (C) 2022 GoodData Corporation +import logging import os from pathlib import Path from unittest import mock @@ -6,6 +7,33 @@ import pytest import yaml +logger = logging.getLogger(__name__) + +_current_dir = Path(__file__).parent.absolute() +_credentials_path = _current_dir / "catalog" / "load" / "data_source_credentials" / "data_sources_credentials.yaml" + +# --------------------------------------------------------------------------- +# Staging data source connection overrides +# Local Docker: jdbc:postgresql://postgres:5432/tiger, user=postgres +# Staging k8s: jdbc:postgresql://cnpg-cluster-pooler:5432/tiger, user=tiger +# --------------------------------------------------------------------------- +_LOCAL_DS_URL = "jdbc:postgresql://postgres:5432/tiger?sslmode=prefer" +_LOCAL_DS_USERNAME = "postgres" +_STAGING_DS_URL = "jdbc:postgresql://cnpg-cluster-pooler:5432/tiger?sslmode=prefer" +_STAGING_DS_USERNAME = "tiger" + +# --------------------------------------------------------------------------- +# Failure tracker — used by session snapshot to decide whether to restore +# --------------------------------------------------------------------------- +_session_has_failures = False + + +def pytest_runtest_makereport(item, call): + """Track whether any test has failed during the session.""" + global _session_has_failures + if call.excinfo is not None: + _session_has_failures = True + def pytest_addoption(parser): default_config_path = Path(__file__).parent / "gd_test_config.yaml" @@ -23,6 +51,12 @@ def test_config(request): with open(config_path) as f: config = yaml.safe_load(f) + # Override token from TOKEN env var (set by make test-staging TOKEN=...) + if config.get("staging", False): + env_token = os.environ.get("TOKEN") + if env_token: + config["token"] = env_token + return config @@ -33,3 +67,361 @@ def setenvvar(monkeypatch): for k, v in envvars.items(): monkeypatch.setenv(k, v) yield + + +# --------------------------------------------------------------------------- +# Staging preflight — validates connectivity and required resources +# --------------------------------------------------------------------------- + + +@pytest.fixture(scope="session", autouse=True) +def staging_preflight(test_config): + """When staging: true, verify connectivity and that required resources exist. + + Calls pytest.exit() on failure so the session stops immediately with a clear + diagnostic instead of cascading into hundreds of confusing errors. + """ + if not test_config.get("staging", False): + yield + return + + from gooddata_sdk import GoodDataSdk + + sdk = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"]) + + # 1. Connectivity check + try: + if not sdk.support.is_available: + pytest.exit("PREFLIGHT FAILED: server responded but is_available returned False") + except Exception as e: + pytest.exit(f"PREFLIGHT FAILED: cannot reach {test_config['host']} — {type(e).__name__}: {e}") + + # 2. Required resources check + missing = [] + user_ids = set() + + # Workspaces + try: + workspace_ids = {ws.id for ws in sdk.catalog_workspace.list_workspaces()} + for ws_id in [test_config["workspace"], test_config["workspace_with_parent"]]: + if ws_id not in workspace_ids: + missing.append(f"workspace '{ws_id}'") # noqa: PERF401 + except Exception as e: + missing.append(f"workspaces (list failed: {e})") + + # Data source + try: + ds_ids = {ds.id for ds in sdk.catalog_data_source.list_data_sources()} + if test_config["data_source"] not in ds_ids: + missing.append(f"data_source '{test_config['data_source']}'") + except Exception as e: + missing.append(f"data_sources (list failed: {e})") + + # Users (reuse list from auto-discovery if available) + if user_ids: + for uid in [test_config["demo_user"], test_config["test_user"]]: + if uid not in user_ids: + missing.append(f"user '{uid}'") # noqa: PERF401 + else: + try: + user_ids = {u.id for u in sdk.catalog_user.list_users()} + for uid in [test_config["demo_user"], test_config["test_user"]]: + if uid not in user_ids: + missing.append(f"user '{uid}'") # noqa: PERF401 + except Exception as e: + missing.append(f"users (list failed: {e})") + + # User groups + try: + group_ids = {g.id for g in sdk.catalog_user.list_user_groups()} + for gid in [test_config["admin_user_group"], test_config["test_user_group"]]: + if gid not in group_ids: + missing.append(f"user_group '{gid}'") # noqa: PERF401 + except Exception as e: + missing.append(f"user_groups (list failed: {e})") + + if missing: + report = "\n - ".join(missing) + pytest.exit(f"PREFLIGHT FAILED: required resources missing:\n - {report}") + + logger.info("Staging preflight passed — all resources present") + yield + + +# --------------------------------------------------------------------------- +# Staging fixture rewriting — patch JDBC URLs in test layout files +# --------------------------------------------------------------------------- + +# Files that contain PostgreSQL JDBC connection strings and need patching +_STAGING_PATCH_FILES = [ + _current_dir + / "catalog" + / "load" + / "gooddata_layouts" + / "default" + / "data_sources" + / "demo-test-ds" + / "demo-test-ds.yaml", + _current_dir + / "catalog" + / "load_with_locale" + / "gooddata_layouts" + / "default" + / "data_sources" + / "demo-test-ds" + / "demo-test-ds.yaml", + _current_dir / "catalog" / "expected" / "declarative_data_sources.json", +] + + +_STAGING_BACKUP_SUFFIX = ".staging-backup" + + +def _backup_path(file_path: Path) -> Path: + return file_path.with_suffix(file_path.suffix + _STAGING_BACKUP_SUFFIX) + + +def _restore_from_backup(file_path: Path) -> None: + """Restore a file from its backup (left over from a previous interrupted run).""" + backup = _backup_path(file_path) + if backup.exists(): + file_path.write_text(backup.read_text()) + backup.unlink() + logger.info(f"Restored from stale backup: {file_path}") + + +def _patch_file_for_staging(file_path: Path) -> bool: + """Replace local JDBC URL/username with staging values. Writes backup to disk for crash safety.""" + if not file_path.exists(): + return False + original = file_path.read_text() + patched = original.replace(_LOCAL_DS_URL, _STAGING_DS_URL).replace( + f"username: {_LOCAL_DS_USERNAME}", f"username: {_STAGING_DS_USERNAME}" + ) + # Also handle JSON format (username as a JSON field) + patched = patched.replace(f'"username": "{_LOCAL_DS_USERNAME}"', f'"username": "{_STAGING_DS_USERNAME}"') + if patched != original: + _backup_path(file_path).write_text(original) + file_path.write_text(patched) + logger.info(f"Patched for staging: {file_path}") + return True + return False + + +def _restore_patched_file(file_path: Path) -> None: + """Restore a file from its backup and remove the backup.""" + backup = _backup_path(file_path) + if backup.exists(): + file_path.write_text(backup.read_text()) + backup.unlink() + logger.info(f"Restored original: {file_path}") + + +def _find_gooddata_layouts_dirs() -> list[Path]: + """Find all gooddata_layouts directories under the test tree.""" + catalog_dir = _current_dir / "catalog" + return sorted(catalog_dir.rglob("gooddata_layouts")) + + +def _create_org_layout_copies(org_id: str) -> list[Path]: + """Copy default/ -> / in gooddata_layouts dirs that have 'default'. + + Always removes existing directories first to avoid stale/incomplete + copies from previous runs. + + Uses shutil.copytree for cross-platform reliability (Windows CI, Docker, worktrees). + Also safe for store/translate tests that write into the org directory. + + Returns list of created directories for cleanup. + """ + import shutil + + created: list[Path] = [] + for layouts_dir in _find_gooddata_layouts_dirs(): + default_dir = layouts_dir / "default" + org_dir = layouts_dir / org_id + if default_dir.is_dir(): + if org_dir.exists(): + shutil.rmtree(org_dir) + logger.info(f"Removed stale layout dir: {org_dir}") + shutil.copytree(default_dir, org_dir) + logger.info(f"Copied layout dir: {default_dir} -> {org_dir}") + created.append(org_dir) + return created + + +@pytest.fixture(scope="session", autouse=True) +def staging_patch_fixtures(test_config, staging_preflight): + """When staging: true, patch test fixtures for the staging environment. + + - Rewrites JDBC connection strings in fixture files + - Copies gooddata_layouts/default/ -> gooddata_layouts// so the SDK + can find layout files (it uses the org ID as the directory name) + + Uses on-disk backups so that interrupted runs self-heal on the next start. + """ + # Always restore leftover backups from a previous interrupted run + for fpath in _STAGING_PATCH_FILES: + _restore_from_backup(fpath) + + if not test_config.get("staging", False): + yield + return + + import shutil + + # 1. Patch JDBC connection strings in fixture files + patched_files = [fpath for fpath in _STAGING_PATCH_FILES if _patch_file_for_staging(fpath)] + logger.info(f"Patched {len(patched_files)} fixture files for staging") + + # 2. Copy layout dirs (gooddata_layouts/default -> gooddata_layouts/) + from gooddata_sdk import GoodDataSdk + + sdk = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"]) + org_id = sdk.catalog_organization.get_organization().id + copied_dirs = _create_org_layout_copies(org_id) + logger.info(f"Created {len(copied_dirs)} layout copies for org '{org_id}'") + + yield + + # Restore patched files from backups + for fpath in patched_files: + _restore_patched_file(fpath) + + # Remove copied directories + for d in copied_dirs: + if d.is_dir(): + shutil.rmtree(d) + logger.info(f"Removed layout copy: {d}") + + +# --------------------------------------------------------------------------- +# Session-level snapshot/restore — safety net for staging +# --------------------------------------------------------------------------- + + +@pytest.fixture(scope="session", autouse=True) +def staging_session_snapshot(test_config, staging_preflight): + """When staging: true, capture full environment state before tests run. + + On teardown, if any test failed, restore everything to the captured state. + This is the last line of defense — per-test snapshot fixtures are the first. + """ + if not test_config.get("staging", False): + yield + return + + from gooddata_sdk import GoodDataSdk + + sdk = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"]) + + # --- Capture --- + snapshot = {} + logger.info("Capturing session snapshot...") + + try: + snapshot["users_groups"] = sdk.catalog_user.get_declarative_users_user_groups() + except Exception as e: + logger.error(f"Snapshot capture failed [users_groups]: {e}") + + try: + snapshot["data_sources"] = sdk.catalog_data_source.get_declarative_data_sources() + except Exception as e: + logger.error(f"Snapshot capture failed [data_sources]: {e}") + + try: + snapshot["workspaces"] = sdk.catalog_workspace.get_declarative_workspaces(exclude=["ACTIVITY_INFO"]) + except Exception as e: + logger.error(f"Snapshot capture failed [workspaces]: {e}") + + try: + snapshot["workspace_data_filters"] = sdk.catalog_workspace.get_declarative_workspace_data_filters() + except Exception as e: + logger.error(f"Snapshot capture failed [workspace_data_filters]: {e}") + + try: + snapshot["org_permissions"] = sdk.catalog_permission.get_declarative_organization_permissions() + except Exception as e: + logger.error(f"Snapshot capture failed [org_permissions]: {e}") + + try: + snapshot["notification_channels"] = sdk.catalog_organization.get_declarative_notification_channels() + except Exception as e: + logger.error(f"Snapshot capture failed [notification_channels]: {e}") + + # Per-workspace permissions + ws_permissions = {} + try: + for ws in sdk.catalog_workspace.list_workspaces(): + try: + ws_permissions[ws.id] = sdk.catalog_permission.get_declarative_permissions(ws.id) + except Exception as e: # noqa: PERF203 + logger.warning(f"Could not capture permissions for workspace {ws.id}: {e}") + except Exception as e: + logger.error(f"Snapshot capture failed [workspace list for permissions]: {e}") + snapshot["ws_permissions"] = ws_permissions + + logger.info("Session snapshot captured") + + # --- Tests run --- + yield snapshot + + # --- Restore (only if failures) --- + if not _session_has_failures: + logger.info("All tests passed — skipping session restore") + return + + logger.warning("Test failures detected — restoring session snapshot...") + + # Restore order matters: users/groups → data sources → workspaces → + # workspace data filters → org permissions → notification channels → + # per-workspace permissions + + if "users_groups" in snapshot: + try: + sdk.catalog_user.put_declarative_users_user_groups(snapshot["users_groups"]) + logger.info("Restored [users_groups]") + except Exception as e: + logger.error(f"RESTORE FAILED [users_groups]: {e}") + + if "data_sources" in snapshot: + try: + sdk.catalog_data_source.put_declarative_data_sources(snapshot["data_sources"], _credentials_path) + logger.info("Restored [data_sources]") + except Exception as e: + logger.error(f"RESTORE FAILED [data_sources]: {e}") + + if "workspaces" in snapshot: + try: + sdk.catalog_workspace.put_declarative_workspaces(snapshot["workspaces"]) + logger.info("Restored [workspaces]") + except Exception as e: + logger.error(f"RESTORE FAILED [workspaces]: {e}") + + if "workspace_data_filters" in snapshot: + try: + sdk.catalog_workspace.put_declarative_workspace_data_filters(snapshot["workspace_data_filters"]) + logger.info("Restored [workspace_data_filters]") + except Exception as e: + logger.error(f"RESTORE FAILED [workspace_data_filters]: {e}") + + if "org_permissions" in snapshot: + try: + sdk.catalog_permission.put_declarative_organization_permissions(snapshot["org_permissions"]) + logger.info("Restored [org_permissions]") + except Exception as e: + logger.error(f"RESTORE FAILED [org_permissions]: {e}") + + if "notification_channels" in snapshot: + try: + sdk.catalog_organization.put_declarative_notification_channels(snapshot["notification_channels"]) + logger.info("Restored [notification_channels]") + except Exception as e: + logger.error(f"RESTORE FAILED [notification_channels]: {e}") + + for ws_id, perms in snapshot.get("ws_permissions", {}).items(): + try: + sdk.catalog_permission.put_declarative_permissions(ws_id, perms) + logger.info(f"Restored [permissions for {ws_id}]") + except Exception as e: # noqa: PERF203 + logger.warning(f"RESTORE FAILED [permissions for {ws_id}]: {e}") diff --git a/packages/gooddata-sdk/tests/gd_test_config_staging.yaml b/packages/gooddata-sdk/tests/gd_test_config_staging.yaml new file mode 100644 index 000000000..ec3127c50 --- /dev/null +++ b/packages/gooddata-sdk/tests/gd_test_config_staging.yaml @@ -0,0 +1,32 @@ +# (C) 2024 GoodData Corporation +# Staging test configuration. +# Token is passed via TOKEN env var from make test-staging TOKEN=... (see conftest.py). +staging: true +host: "https://python-sdk-dex.dev-latest.stg11.panther.intgdc.com" +token: "" +workspace: "demo" +workspace_name: "Demo" +workspace_with_parent: "demo_west" +workspace_with_parent_name: "Demo West" +header_host: python-sdk-dex.dev-latest.stg11.panther.intgdc.com +data_source: "demo-test-ds" +data_source2: "demo-bigquery-ds" +workspace_test: "demo_testing" +test_user: "demo2" +test_user_group: "demoGroup" +test_new_user: "newUser" +test_new_user_group: "newUserGroup" +test_new_user_data_filter: "newUserDataFilter" +demo_user: "demo" +admin_user_group: "adminGroup" +bigquery_token: "dummy-bigquery-token" +bigquery_token_file: "" +visualization_id: "customers_trend" +visualization_name: "Customers Trend" +databricks_client_secret: "dummy-databricks-secret" +databricks_token: "dummy-databricks-token" +# Staging PostgreSQL connection (used by fixture patching in conftest.py) +# Local Docker uses postgres:5432 with user=postgres +# Staging k8s uses cnpg-cluster-pooler:5432 with user=tiger +staging_ds_url: "jdbc:postgresql://cnpg-cluster-pooler:5432/tiger?sslmode=prefer" +staging_ds_username: "tiger" diff --git a/packages/gooddata-sdk/tox.ini b/packages/gooddata-sdk/tox.ini index e009c4d9a..aeaa31d03 100644 --- a/packages/gooddata-sdk/tox.ini +++ b/packages/gooddata-sdk/tox.ini @@ -8,6 +8,9 @@ package = wheel wheel_build_env = .pkg dependency_groups = test +pass_env = + OVERWRITE + TOKEN setenv = COVERAGE_CORE=sysmon commands = diff --git a/packages/tests-support/clean_staging.py b/packages/tests-support/clean_staging.py new file mode 100644 index 000000000..3521873f0 --- /dev/null +++ b/packages/tests-support/clean_staging.py @@ -0,0 +1,74 @@ +# (C) 2024 GoodData Corporation +"""Wipe all user-created resources from a staging environment. + +Run `load-staging` afterward to restore the expected test state. +""" + +import os + +import requests + +staging = os.environ.get("STAGING", "").lower() in ("1", "true", "yes") + +_STAGING_HOST = "https://python-sdk-dex.dev-latest.stg11.panther.intgdc.com" +_STAGING_HEADER_HOST = "python-sdk-dex.dev-latest.stg11.panther.intgdc.com" + +if staging: + host = os.environ.get("HOST", _STAGING_HOST) + token = os.environ["TOKEN"] + header_host = os.environ.get("HEADER_HOST", _STAGING_HEADER_HOST) +else: + host = os.environ.get("HOST", "http://localhost:3000") + token = os.environ.get("TOKEN", "YWRtaW46Ym9vdHN0cmFwOmFkbWluMTIz") + header_host = os.environ.get("HEADER_HOST", None) + +api_version = "v1" + + +def rest_op(method, url_path, data=None): + all_headers = { + "Authorization": f"Bearer {token}", + "Content-Type": "application/json", + } + if header_host: + all_headers["Host"] = header_host + url = f"{host}/api/{api_version}/{url_path}" + resp = getattr(requests, method)(url=url, headers=all_headers, json=data) + if resp.status_code >= 300: + print(f" WARNING: {method.upper()} {url_path} returned {resp.status_code}: {resp.text[:200]}") + else: + print(f" OK: {method.upper()} {url_path}") + + +def clean(): + mode = "STAGING" if staging else "LOCAL" + print(f"=== Cleaning environment ({mode}) ===", flush=True) + + # Order matters: permissions reference users/groups, workspaces reference data sources. + # 1. Remove workspace permissions first + print("Removing workspace permissions...", flush=True) + rest_op("put", "layout/workspaces/demo/permissions", {"hierarchyPermissions": [], "permissions": []}) + + # 2. Remove workspaces (removes all workspace content) + print("Removing workspaces...", flush=True) + rest_op("put", "layout/workspaces", {"workspaces": [], "workspaceDataFilters": []}) + + # 3. Remove data sources + print("Removing data sources...", flush=True) + rest_op("put", "layout/dataSources", {"dataSources": []}) + + # 4. Remove non-admin users (keep admin) + print("Removing users (keeping admin)...", flush=True) + rest_op( + "put", "layout/users", {"users": [{"id": "admin", "userGroups": [{"id": "adminGroup", "type": "userGroup"}]}]} + ) + + # 5. Remove non-admin user groups (keep adminGroup) + print("Removing user groups (keeping adminGroup)...", flush=True) + rest_op("put", "layout/userGroups", {"userGroups": [{"id": "adminGroup"}]}) + + print("=== Clean complete ===", flush=True) + + +if __name__ == "__main__": + clean() diff --git a/packages/tests-support/fixtures/demo_data_sources.json b/packages/tests-support/fixtures/demo_data_sources.json index 0e443d2c5..0fc0c51ee 100644 --- a/packages/tests-support/fixtures/demo_data_sources.json +++ b/packages/tests-support/fixtures/demo_data_sources.json @@ -8,6 +8,7 @@ "url": "jdbc:postgresql://postgres:5432/tiger?sslmode=prefer", "username": "postgres", "password": "passw0rd", + "alternativeDataSourceId": "ds-put-abc-id", "permissions": [ { "assignee": { diff --git a/packages/tests-support/upload_demo_layout.py b/packages/tests-support/upload_demo_layout.py index 2beadb2f5..1dcb4ebd5 100644 --- a/packages/tests-support/upload_demo_layout.py +++ b/packages/tests-support/upload_demo_layout.py @@ -7,14 +7,32 @@ import requests fixtures_dir = Path(os.environ.get("FIXTURES_DIR", Path(os.path.curdir) / "fixtures")) -host = os.environ.get("HOST", "http://localhost:3000") -token = os.environ.get("TOKEN", "YWRtaW46Ym9vdHN0cmFwOmFkbWluMTIz") -header_host = os.environ.get("HEADER_HOST", None) +staging = os.environ.get("STAGING", "").lower() in ("1", "true", "yes") + +# Staging defaults — only TOKEN must be provided via env var +_STAGING_HOST = "https://python-sdk-dex.dev-latest.stg11.panther.intgdc.com" +_STAGING_HEADER_HOST = "python-sdk-dex.dev-latest.stg11.panther.intgdc.com" + +if staging: + host = os.environ.get("HOST", _STAGING_HOST) + token = os.environ["TOKEN"] # required — no default for staging tokens + header_host = os.environ.get("HEADER_HOST", _STAGING_HEADER_HOST) +else: + host = os.environ.get("HOST", "http://localhost:3000") + token = os.environ.get("TOKEN", "YWRtaW46Ym9vdHN0cmFwOmFkbWluMTIz") + header_host = os.environ.get("HEADER_HOST", None) content_type_jsonapi = "application/vnd.gooddata.api+json" content_type_default = "application/json" headers = {"Host": header_host} api_version = "v1" +# Staging overrides for data source connection +# Local Docker: postgres:5432, user=postgres +# Staging k8s: cnpg-cluster-pooler:5432, user=tiger +STAGING_DS_URL = "jdbc:postgresql://cnpg-cluster-pooler:5432/tiger?sslmode=prefer" +STAGING_DS_USERNAME = "tiger" +STAGING_DS_PASSWORD = "passw0rd" + def rest_op(op, url_path, data=None, raise_ex=True): all_headers = { @@ -60,12 +78,24 @@ def rest_op_default(op, url_path, data_json_path=None, raise_ex=True): return rest_op(op, url_path, data_json_path, raise_ex) +def get_org_id(): + """Return the organization ID — 'default' for local Docker, auto-discovered for staging.""" + if not staging: + return "default" + # On staging, org ID matches the hostname prefix (e.g. python-sdk-dex) + org_id = os.environ.get("ORG_ID", "") + if not org_id and header_host: + org_id = header_host.split(".")[0] + return org_id or "default" + + def wait_platform_up(): # wait till GoodData is up and ready to receive requests - print("Waiting till GoodData is up", flush=True) + org_id = get_org_id() + print(f"Waiting till GoodData is up (org={org_id})", flush=True) while True: try: - result = rest_op_jsonapi("get", f"api/{api_version}/entities/admin/organizations/default", raise_ex=False) + result = rest_op_jsonapi("get", f"api/{api_version}/entities/admin/organizations/{org_id}", raise_ex=False) if result is not None: print("GoodData is up", flush=True) break @@ -85,14 +115,35 @@ def create_entity(entity_id, entity_data, entity_type, api_path, action): return result +def patch_data_sources_for_staging(data_sources): + """Patch data source fixtures with staging PostgreSQL connection details.""" + for ds in data_sources.get("dataSources", []): + ds["url"] = STAGING_DS_URL + ds["username"] = STAGING_DS_USERNAME + ds["password"] = STAGING_DS_PASSWORD + print(f" Patched DS '{ds['id']}': url={ds['url']}, username={ds['username']}", flush=True) + return data_sources + + def update_layout(): + org_id = get_org_id() + mode = "STAGING" if staging else "LOCAL" + print(f"=== Running in {mode} mode (org={org_id}) ===", flush=True) + user_groups = read_data_from_file(fixtures_dir / "user_groups.json") - user_auth = read_data_from_file(fixtures_dir / "user_auth.json") - user = read_data_from_file(fixtures_dir / "user.json") + demo_user_auth = read_data_from_file(fixtures_dir / "demo_user_auth.json") + demo_user = read_data_from_file(fixtures_dir / "demo_user.json") + demo2_user_auth = read_data_from_file(fixtures_dir / "user_auth.json") + demo2_user = read_data_from_file(fixtures_dir / "user.json") data_sources = read_data_from_file(fixtures_dir / "demo_data_sources.json") hierarchy = read_data_from_file(fixtures_dir / "demo_declarative_hierarchy.json") permissions = read_data_from_file(fixtures_dir / "workspace_permissions.json") + # Patch data source connection for staging + if staging: + print("Patching data sources for staging...", flush=True) + data_sources = patch_data_sources_for_staging(data_sources) + # TODO: use python-sdk support wait_platform_up() @@ -102,7 +153,7 @@ def update_layout(): print("Enabling feature flags on organization...", flush=True) org_update = { "data": { - "id": "default", + "id": org_id, "type": "organization", "attributes": { "earlyAccessValues": [ @@ -118,16 +169,33 @@ def update_layout(): }, } } - rest_op_jsonapi("patch", f"api/{api_version}/entities/admin/organizations/default", org_update) + rest_op_jsonapi("patch", f"api/{api_version}/entities/admin/organizations/{org_id}", org_update) print("Uploading userGroups", flush=True) rest_op_default("put", f"api/{api_version}/layout/userGroups", user_groups) - response = create_entity( - user_auth["email"], user_auth, "user auth", f"api/{api_version}/auth/users", rest_op_default - ) - user["data"]["attributes"]["authenticationId"] = response["authenticationId"] - create_entity(user["data"]["id"], user, "user", f"api/{api_version}/entities/users", rest_op_jsonapi) + users_to_create = [ + ("demo", demo_user_auth, demo_user), + ("demo2", demo2_user_auth, demo2_user), + ] + for user_label, user_auth, user in users_to_create: + if staging: + # On staging with DEX, user creation may not work (DEX manages auth). + # Try anyway but don't fail the entire upload. + try: + response = create_entity( + user_auth["email"], user_auth, "user auth", f"api/{api_version}/auth/users", rest_op_default + ) + user["data"]["attributes"]["authenticationId"] = response["authenticationId"] + create_entity(user["data"]["id"], user, "user", f"api/{api_version}/entities/users", rest_op_jsonapi) + except Exception as e: + print(f"WARNING: User '{user_label}' creation failed on staging (expected with DEX): {e}", flush=True) + else: + response = create_entity( + user_auth["email"], user_auth, "user auth", f"api/{api_version}/auth/users", rest_op_default + ) + user["data"]["attributes"]["authenticationId"] = response["authenticationId"] + create_entity(user["data"]["id"], user, "user", f"api/{api_version}/entities/users", rest_op_jsonapi) print("Uploading test DS with physical model for demo", flush=True) rest_op_default("put", f"api/{api_version}/layout/dataSources", data_sources) diff --git a/project_common.mk b/project_common.mk index 762243b3e..f2d92f4ee 100644 --- a/project_common.mk +++ b/project_common.mk @@ -66,6 +66,11 @@ test-ci: TEST_CI_PROJECT=$(CURR_DIR_BASE_NAME) $(MAKE) -C ../.. -f ci_tests.mk test-ci +.PHONY: test-staging +test-staging: + @test -n "$(TOKEN)" || (echo "ERROR: TOKEN is required. Usage: make test-staging TOKEN=" && exit 1) + TOKEN=$(TOKEN) STAGING=1 uv run tox -v $(TOX_FLAGS) $(LOCAL_TEST_ENVS) -- --gd-test-config=tests/gd_test_config_staging.yaml $(LOCAL_ADD_ARGS) + # this is effective for gooddata-sdk only now - it should be part of test fixtures # remove this target once implemented in pytest global fixture .PHONY: remove-store-data From d2e0811a46901019e5832b8d8f98e1098f5010d7 Mon Sep 17 00:00:00 2001 From: Jan Tychtl Date: Thu, 12 Mar 2026 10:16:43 +0100 Subject: [PATCH 3/4] chore: regenerate test cassettes --- .../execute_compute_table_all_columns.yaml | 6 +- .../execute_compute_table_metrics_only.yaml | 6 +- ...ompute_table_with_reduced_granularity.yaml | 6 +- .../fixtures/execute_insight_all_columns.yaml | 6 +- .../execute_insight_some_columns.yaml | 6 +- .../import_compute_without_restrictions.yaml | 40 +- .../import_insights_without_restrictions.yaml | 40 +- ...ame_for_exec_def_bytes_limits_failure.yaml | 10 +- ...or_exec_def_dimensions_limits_failure.yaml | 10 +- .../dataframe_for_exec_def_one_dim1.yaml | 16 +- .../dataframe_for_exec_def_one_dim2.yaml | 28 +- .../dataframe_for_exec_def_totals1.yaml | 16 +- .../dataframe_for_exec_def_totals2.yaml | 16 +- .../dataframe_for_exec_def_totals3.yaml | 16 +- .../dataframe_for_exec_def_totals4.yaml | 16 +- .../dataframe_for_exec_def_two_dim1.yaml | 22 +- .../dataframe_for_exec_def_two_dim2.yaml | 20 +- .../dataframe_for_exec_def_two_dim3.yaml | 16 +- .../fixtures/dataframe_for_items.yaml | 6 +- .../dataframe_for_items_no_index.yaml | 6 +- .../fixtures/dataframe_for_visualization.yaml | 6 +- .../dataframe_for_visualization_date.yaml | 6 +- .../dataframe_for_visualization_no_index.yaml | 6 +- .../fixtures/empty_indexed_dataframe.yaml | 6 +- .../fixtures/empty_not_indexed_dataframe.yaml | 6 +- .../dataframe/fixtures/filtered_empty_df.yaml | 6 +- ...ulti_index_filtered_metrics_and_label.yaml | 10 +- ...ndex_filtered_metrics_and_label_reuse.yaml | 6 +- .../fixtures/multi_index_metrics.yaml | 6 +- .../multi_index_metrics_and_label.yaml | 10 +- ...t_indexed_filtered_metrics_and_labels.yaml | 6 +- .../fixtures/not_indexed_metrics.yaml | 6 +- .../not_indexed_metrics_and_labels.yaml | 6 +- ...mple_index_filtered_metrics_and_label.yaml | 6 +- .../fixtures/simple_index_metrics.yaml | 6 +- .../simple_index_metrics_and_label.yaml | 6 +- .../simple_index_metrics_no_duplicate.yaml | 6 +- .../fixtures/multi_index_filtered_series.yaml | 6 +- .../fixtures/multi_index_metric_series.yaml | 6 +- .../not_indexed_filtered_metric_series.yaml | 12 +- .../fixtures/not_indexed_label_series.yaml | 6 +- ...indexed_label_series_with_granularity.yaml | 6 +- .../fixtures/not_indexed_metric_series.yaml | 6 +- ...ndexed_metric_series_with_granularity.yaml | 6 +- .../simple_index_filtered_series.yaml | 6 +- .../fixtures/simple_index_label_series.yaml | 6 +- .../fixtures/simple_index_metric_series.yaml | 6 +- .../fixtures/data_sources/bigquery.yaml | 6 +- .../data_sources/demo_data_sources_list.yaml | 5 +- ...t_declarative_data_sources_connection.yaml | 2 +- .../demo_register_upload_notification.yaml | 8 +- .../catalog/fixtures/data_sources/dremio.yaml | 6 +- .../catalog/fixtures/data_sources/patch.yaml | 17 +- .../fixtures/data_sources/redshift.yaml | 6 +- .../fixtures/data_sources/snowflake.yaml | 12 +- .../data_sources/test_create_update.yaml | 79 +-- .../fixtures/data_sources/vertica.yaml | 6 +- .../organization/create_csp_directive.yaml | 46 -- .../fixtures/organization/create_jwk.yaml | 48 +- .../create_organization_setting.yaml | 46 -- .../organization/delete_csp_directive.yaml | 68 +- .../fixtures/organization/delete_jwk.yaml | 70 +- .../organization/delete_llm_endpoint.yaml | 2 +- .../delete_organization_setting.yaml | 68 +- .../layout_notification_channels.yaml | 129 +--- .../organization/list_csp_directives.yaml | 96 +-- .../fixtures/organization/list_jwk.yaml | 100 +-- .../organization/list_llm_endpoints.yaml | 50 +- .../list_organization_settings.yaml | 96 +-- .../organization/update_allowed_origins.yaml | 187 +++--- .../organization/update_csp_directive.yaml | 46 -- .../fixtures/organization/update_jwk.yaml | 48 +- .../fixtures/organization/update_name.yaml | 100 --- .../update_organization_setting.yaml | 46 -- .../list_dashboard_permissions.yaml | 45 -- ...ard_permissions_declarative_workspace.yaml | 45 -- .../manage_organization_permissions.yaml | 46 -- ..._declarative_organization_permissions.yaml | 46 -- .../put_declarative_permissions.yaml | 44 -- .../fixtures/users/create_delete_user.yaml | 103 +-- .../users/create_delete_user_group.yaml | 92 +-- .../fixtures/users/get_declarative_users.yaml | 8 +- .../get_declarative_users_user_groups.yaml | 8 +- .../catalog/fixtures/users/get_user.yaml | 2 +- .../catalog/fixtures/users/list_users.yaml | 4 +- .../load_and_put_declarative_user_groups.yaml | 18 +- .../users/load_and_put_declarative_users.yaml | 12 +- ...and_put_declarative_users_user_groups.yaml | 12 +- .../users/put_declarative_user_groups.yaml | 18 +- .../fixtures/users/put_declarative_users.yaml | 20 +- .../put_declarative_users_user_groups.yaml | 20 +- .../users/store_declarative_users.yaml | 8 +- .../store_declarative_users_user_groups.yaml | 8 +- .../fixtures/users/test_api_tokens.yaml | 48 +- .../users/test_user_add_user_group.yaml | 2 +- .../users/test_user_add_user_groups.yaml | 2 +- .../users/test_user_remove_user_groups.yaml | 2 +- .../users/test_user_replace_user_groups.yaml | 2 +- .../catalog/fixtures/users/update_user.yaml | 103 +-- .../fixtures/users/update_user_group.yaml | 180 ----- .../analytics_store_load.yaml | 176 ++--- .../workspace_content/demo_catalog.yaml | 88 +-- .../demo_catalog_availability.yaml | 88 +-- .../demo_catalog_list_attributes.yaml | 4 +- .../demo_catalog_list_metrics.yaml | 48 +- .../demo_get_dependent_entities_graph.yaml | 254 +++---- ...and_modify_ds_and_put_declarative_ldm.yaml | 6 +- ...d_and_put_declarative_analytics_model.yaml | 2 +- .../demo_load_and_put_declarative_ldm.yaml | 2 +- .../demo_put_declarative_analytics_model.yaml | 2 +- .../demo_put_declarative_ldm.yaml | 2 +- ...emo_store_declarative_analytics_model.yaml | 176 ++--- .../explicit_workspace_data_filter.yaml | 88 +-- .../workspace_content/label_elements.yaml | 20 +- .../workspaces/create_workspace_setting.yaml | 48 +- .../workspaces/delete_workspace_setting.yaml | 48 +- .../workspaces/demo_clone_workspace.yaml | 630 +++++++++--------- .../workspaces/demo_create_workspace.yaml | 2 +- .../demo_put_declarative_workspace.yaml | 2 +- .../demo_store_declarative_workspaces.yaml | 176 ++--- .../workspaces/demo_translate_workspace.yaml | 270 ++++---- .../workspaces/layout_automations.yaml | 42 -- .../workspaces/layout_filter_views.yaml | 42 -- .../workspaces/list_workspace_settings.yaml | 50 +- .../workspaces/update_workspace_setting.yaml | 48 +- .../user_data_filters_for_user_group.yaml | 2 +- .../user_data_filters_life_cycle.yaml | 6 +- .../export/fixtures/test_export_csv.yaml | 14 +- .../test_export_csv_by_visualization_id.yaml | 18 +- .../export/fixtures/test_export_excel.yaml | 66 +- ...test_export_excel_by_visualization_id.yaml | 72 +- .../table_with_attribute_and_metric.yaml | 6 +- ...able_with_attribute_metric_and_filter.yaml | 6 +- .../table_with_attribute_show_all_values.yaml | 18 +- .../fixtures/table_with_just_attribute.yaml | 6 +- .../fixtures/table_with_just_metric.yaml | 6 +- .../tests-support/fixtures/demo_user.json | 19 + .../fixtures/demo_user_auth.json | 5 + 138 files changed, 1845 insertions(+), 3488 deletions(-) create mode 100644 packages/tests-support/fixtures/demo_user.json create mode 100644 packages/tests-support/fixtures/demo_user_auth.json diff --git a/packages/gooddata-fdw/tests/execute/fixtures/execute_compute_table_all_columns.yaml b/packages/gooddata-fdw/tests/execute/fixtures/execute_compute_table_all_columns.yaml index e2f51890a..0b590b7a4 100644 --- a/packages/gooddata-fdw/tests/execute/fixtures/execute_compute_table_all_columns.yaml +++ b/packages/gooddata-fdw/tests/execute/fixtures/execute_compute_table_all_columns.yaml @@ -103,7 +103,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - d9864393-ac2a-4c0a-b3ea-aa9e5abb9b70 + - 2b4494d5-cfff-4aac-b526-08f06296ecad X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -155,10 +155,10 @@ interactions: name: Revenue localIdentifier: dim_1 links: - executionResult: a25bd79d690d6196246e00dcba57712fc434bd1e:20b1683c82bd7eab9a6110480cce897ed8639125e12564ab7a9b199c38f5b081 + executionResult: 9f0feba6cd8bfad2b982d1245ee64122d7e14937:6efde536757f8663ae735ec4d2533a93421e1066c7522596bdf317ff13c3b2b9 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/a25bd79d690d6196246e00dcba57712fc434bd1e%3A20b1683c82bd7eab9a6110480cce897ed8639125e12564ab7a9b199c38f5b081?offset=0%2C0&limit=512%2C256 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/9f0feba6cd8bfad2b982d1245ee64122d7e14937%3A6efde536757f8663ae735ec4d2533a93421e1066c7522596bdf317ff13c3b2b9?offset=0%2C0&limit=512%2C256 body: null headers: Accept: diff --git a/packages/gooddata-fdw/tests/execute/fixtures/execute_compute_table_metrics_only.yaml b/packages/gooddata-fdw/tests/execute/fixtures/execute_compute_table_metrics_only.yaml index 8753c5f27..edca6ed3c 100644 --- a/packages/gooddata-fdw/tests/execute/fixtures/execute_compute_table_metrics_only.yaml +++ b/packages/gooddata-fdw/tests/execute/fixtures/execute_compute_table_metrics_only.yaml @@ -89,7 +89,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - c734cef7-e489-4753-b34e-d4b6d19d5e35 + - 984d782f-bf8e-40e5-8d4b-9d84984d4eb6 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -109,10 +109,10 @@ interactions: name: Revenue localIdentifier: dim_0 links: - executionResult: a6c97ee6a244521dfb7c5bd6ffb34e93baecdcc5:eda7cc427233858f3b2b46329904531410365a20487e2ebe8361446ec734ff3f + executionResult: 6ba20d9b8acb633a80047ac871c69ad4f64faaab:04defe5c79ff55f293529ed3305f8c4b26f0ebe412a95eab89a0a89652ddddc5 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/a6c97ee6a244521dfb7c5bd6ffb34e93baecdcc5%3Aeda7cc427233858f3b2b46329904531410365a20487e2ebe8361446ec734ff3f?offset=0&limit=256 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/6ba20d9b8acb633a80047ac871c69ad4f64faaab%3A04defe5c79ff55f293529ed3305f8c4b26f0ebe412a95eab89a0a89652ddddc5?offset=0&limit=256 body: null headers: Accept: diff --git a/packages/gooddata-fdw/tests/execute/fixtures/execute_compute_table_with_reduced_granularity.yaml b/packages/gooddata-fdw/tests/execute/fixtures/execute_compute_table_with_reduced_granularity.yaml index c6f94866c..cc01bcf90 100644 --- a/packages/gooddata-fdw/tests/execute/fixtures/execute_compute_table_with_reduced_granularity.yaml +++ b/packages/gooddata-fdw/tests/execute/fixtures/execute_compute_table_with_reduced_granularity.yaml @@ -78,7 +78,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 48a7f8d7-8e1d-48f0-b4e9-1843f4a32f70 + - 52586cb8-42a0-4e7d-920a-9d54979c792c X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -111,10 +111,10 @@ interactions: name: Revenue localIdentifier: dim_1 links: - executionResult: 1c8a8d0eb53912d784b65063c26f913b0b18d952:54c72a97fc224a9abadc15b2ff2f416c182af9b5d412663bc0ee0978da974be6 + executionResult: 129929b1548565aa94bae375dedf513aefd53ae5:8a1cd75f52c383e06727e93524888ee073fbf17146242407503c3876d5dd2195 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/1c8a8d0eb53912d784b65063c26f913b0b18d952%3A54c72a97fc224a9abadc15b2ff2f416c182af9b5d412663bc0ee0978da974be6?offset=0%2C0&limit=512%2C256 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/129929b1548565aa94bae375dedf513aefd53ae5%3A8a1cd75f52c383e06727e93524888ee073fbf17146242407503c3876d5dd2195?offset=0%2C0&limit=512%2C256 body: null headers: Accept: diff --git a/packages/gooddata-fdw/tests/execute/fixtures/execute_insight_all_columns.yaml b/packages/gooddata-fdw/tests/execute/fixtures/execute_insight_all_columns.yaml index 6ad9bb242..e18a1b35c 100644 --- a/packages/gooddata-fdw/tests/execute/fixtures/execute_insight_all_columns.yaml +++ b/packages/gooddata-fdw/tests/execute/fixtures/execute_insight_all_columns.yaml @@ -375,7 +375,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 466d13f5-b17e-4fe2-ae20-ab164bb51af4 + - e01619b9-9704-4b56-b93d-156c0b7e97e3 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -427,10 +427,10 @@ interactions: name: Revenue localIdentifier: dim_1 links: - executionResult: 8784b17f2b3dfe33a3f74f622cda4a7d45fa5698:0ccc9db8bf509fced9443d1cca405bc48fb287d977ab4effd1cc95e6f372b03e + executionResult: 1bb0c98cd7d461a2904ad31bf96a3f56d19d86b0:1559d18ef82f3b284457d50066e0e029ab207bf769d99e37ce3078095648ef4c - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/8784b17f2b3dfe33a3f74f622cda4a7d45fa5698%3A0ccc9db8bf509fced9443d1cca405bc48fb287d977ab4effd1cc95e6f372b03e?offset=0%2C0&limit=512%2C256 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/1bb0c98cd7d461a2904ad31bf96a3f56d19d86b0%3A1559d18ef82f3b284457d50066e0e029ab207bf769d99e37ce3078095648ef4c?offset=0%2C0&limit=512%2C256 body: null headers: Accept: diff --git a/packages/gooddata-fdw/tests/execute/fixtures/execute_insight_some_columns.yaml b/packages/gooddata-fdw/tests/execute/fixtures/execute_insight_some_columns.yaml index 1147f4028..e5dc32697 100644 --- a/packages/gooddata-fdw/tests/execute/fixtures/execute_insight_some_columns.yaml +++ b/packages/gooddata-fdw/tests/execute/fixtures/execute_insight_some_columns.yaml @@ -375,7 +375,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 9f593c36-2447-440c-894e-14e8be58a021 + - 85286b41-74df-47a2-a24d-6b9025e529e9 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -427,10 +427,10 @@ interactions: name: Revenue localIdentifier: dim_1 links: - executionResult: 8784b17f2b3dfe33a3f74f622cda4a7d45fa5698:0ccc9db8bf509fced9443d1cca405bc48fb287d977ab4effd1cc95e6f372b03e + executionResult: 1bb0c98cd7d461a2904ad31bf96a3f56d19d86b0:1559d18ef82f3b284457d50066e0e029ab207bf769d99e37ce3078095648ef4c - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/8784b17f2b3dfe33a3f74f622cda4a7d45fa5698%3A0ccc9db8bf509fced9443d1cca405bc48fb287d977ab4effd1cc95e6f372b03e?offset=0%2C0&limit=512%2C256 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/1bb0c98cd7d461a2904ad31bf96a3f56d19d86b0%3A1559d18ef82f3b284457d50066e0e029ab207bf769d99e37ce3078095648ef4c?offset=0%2C0&limit=512%2C256 body: null headers: Accept: diff --git a/packages/gooddata-fdw/tests/import_foreign_schema/fixtures/import_compute_without_restrictions.yaml b/packages/gooddata-fdw/tests/import_foreign_schema/fixtures/import_compute_without_restrictions.yaml index 81f1dc8ba..52d3c0e85 100644 --- a/packages/gooddata-fdw/tests/import_foreign_schema/fixtures/import_compute_without_restrictions.yaml +++ b/packages/gooddata-fdw/tests/import_foreign_schema/fixtures/import_compute_without_restrictions.yaml @@ -530,10 +530,10 @@ interactions: type: dataset labels: data: - - id: geo__state__location - type: label - id: state type: label + - id: geo__state__location + type: label type: attribute - attributes: title: Type @@ -600,28 +600,28 @@ interactions: type: attribute referenceProperties: - identifier: - id: campaigns + id: products type: dataset multivalue: false sources: - - column: campaign_id + - column: product_id dataType: INT target: - id: campaign_id + id: product_id type: attribute isNullable: null nullValue: null sourceColumns: null sourceColumnDataTypes: null - identifier: - id: customers + id: campaigns type: dataset multivalue: false sources: - - column: customer_id + - column: campaign_id dataType: INT target: - id: customer_id + id: campaign_id type: attribute isNullable: null nullValue: null @@ -642,14 +642,14 @@ interactions: sourceColumns: null sourceColumnDataTypes: null - identifier: - id: products + id: customers type: dataset multivalue: false sources: - - column: product_id + - column: customer_id dataType: INT target: - id: product_id + id: customer_id type: attribute isNullable: null nullValue: null @@ -1262,28 +1262,28 @@ interactions: type: attribute referenceProperties: - identifier: - id: campaigns + id: products type: dataset multivalue: false sources: - - column: campaign_id + - column: product_id dataType: INT target: - id: campaign_id + id: product_id type: attribute isNullable: null nullValue: null sourceColumns: null sourceColumnDataTypes: null - identifier: - id: customers + id: campaigns type: dataset multivalue: false sources: - - column: customer_id + - column: campaign_id dataType: INT target: - id: customer_id + id: campaign_id type: attribute isNullable: null nullValue: null @@ -1304,14 +1304,14 @@ interactions: sourceColumns: null sourceColumnDataTypes: null - identifier: - id: products + id: customers type: dataset multivalue: false sources: - - column: product_id + - column: customer_id dataType: INT target: - id: product_id + id: customer_id type: attribute isNullable: null nullValue: null diff --git a/packages/gooddata-fdw/tests/import_foreign_schema/fixtures/import_insights_without_restrictions.yaml b/packages/gooddata-fdw/tests/import_foreign_schema/fixtures/import_insights_without_restrictions.yaml index 275d98078..d66aeabbf 100644 --- a/packages/gooddata-fdw/tests/import_foreign_schema/fixtures/import_insights_without_restrictions.yaml +++ b/packages/gooddata-fdw/tests/import_foreign_schema/fixtures/import_insights_without_restrictions.yaml @@ -530,10 +530,10 @@ interactions: type: dataset labels: data: - - id: geo__state__location - type: label - id: state type: label + - id: geo__state__location + type: label type: attribute - attributes: title: Type @@ -600,28 +600,28 @@ interactions: type: attribute referenceProperties: - identifier: - id: campaigns + id: products type: dataset multivalue: false sources: - - column: campaign_id + - column: product_id dataType: INT target: - id: campaign_id + id: product_id type: attribute isNullable: null nullValue: null sourceColumns: null sourceColumnDataTypes: null - identifier: - id: customers + id: campaigns type: dataset multivalue: false sources: - - column: customer_id + - column: campaign_id dataType: INT target: - id: customer_id + id: campaign_id type: attribute isNullable: null nullValue: null @@ -642,14 +642,14 @@ interactions: sourceColumns: null sourceColumnDataTypes: null - identifier: - id: products + id: customers type: dataset multivalue: false sources: - - column: product_id + - column: customer_id dataType: INT target: - id: product_id + id: customer_id type: attribute isNullable: null nullValue: null @@ -1262,28 +1262,28 @@ interactions: type: attribute referenceProperties: - identifier: - id: campaigns + id: products type: dataset multivalue: false sources: - - column: campaign_id + - column: product_id dataType: INT target: - id: campaign_id + id: product_id type: attribute isNullable: null nullValue: null sourceColumns: null sourceColumnDataTypes: null - identifier: - id: customers + id: campaigns type: dataset multivalue: false sources: - - column: customer_id + - column: campaign_id dataType: INT target: - id: customer_id + id: campaign_id type: attribute isNullable: null nullValue: null @@ -1304,14 +1304,14 @@ interactions: sourceColumns: null sourceColumnDataTypes: null - identifier: - id: products + id: customers type: dataset multivalue: false sources: - - column: product_id + - column: customer_id dataType: INT target: - id: product_id + id: customer_id type: attribute isNullable: null nullValue: null diff --git a/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_bytes_limits_failure.yaml b/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_bytes_limits_failure.yaml index 959b7164f..ef21228dc 100644 --- a/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_bytes_limits_failure.yaml +++ b/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_bytes_limits_failure.yaml @@ -90,7 +90,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 2a9e0aa3-f2dc-4d2a-8938-ae15b7612744 + - ed4ed1ad-5793-4f34-8fc0-a8ac887121bd X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -153,10 +153,10 @@ interactions: name: Order Amount localIdentifier: dim_1 links: - executionResult: a58e42996ad852ed5bbebabeb0abf642c2443b8d:7bc2dc84d2f66a82ab208d2901c2a55c9f03f383eb669cfbea586ba9f4119a97 + executionResult: 126301ac1374aad1a057c4832924042c597b802d:b3df629b9bfd96c65a578895e6241c4100ac6b1b608b31d4347cd98378bbafd5 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/a58e42996ad852ed5bbebabeb0abf642c2443b8d%3A7bc2dc84d2f66a82ab208d2901c2a55c9f03f383eb669cfbea586ba9f4119a97/metadata + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/126301ac1374aad1a057c4832924042c597b802d%3Ab3df629b9bfd96c65a578895e6241c4100ac6b1b608b31d4347cd98378bbafd5/metadata body: null headers: Accept: @@ -296,7 +296,7 @@ interactions: name: Order Amount localIdentifier: dim_1 links: - executionResult: a58e42996ad852ed5bbebabeb0abf642c2443b8d:7bc2dc84d2f66a82ab208d2901c2a55c9f03f383eb669cfbea586ba9f4119a97 + executionResult: 126301ac1374aad1a057c4832924042c597b802d:b3df629b9bfd96c65a578895e6241c4100ac6b1b608b31d4347cd98378bbafd5 resultSpec: dimensions: - localIdentifier: dim_0 @@ -313,7 +313,7 @@ interactions: resultSize: 4625 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/a58e42996ad852ed5bbebabeb0abf642c2443b8d%3A7bc2dc84d2f66a82ab208d2901c2a55c9f03f383eb669cfbea586ba9f4119a97?offset=0%2C0&limit=100%2C100 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/126301ac1374aad1a057c4832924042c597b802d%3Ab3df629b9bfd96c65a578895e6241c4100ac6b1b608b31d4347cd98378bbafd5?offset=0%2C0&limit=100%2C100 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_dimensions_limits_failure.yaml b/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_dimensions_limits_failure.yaml index bcc7e8626..373132c31 100644 --- a/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_dimensions_limits_failure.yaml +++ b/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_dimensions_limits_failure.yaml @@ -90,7 +90,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 679bbe1e-8fc9-41e4-b1f3-03d4f0fabbcc + - 47b010b1-8895-43a3-abb3-65ca27214b06 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -153,10 +153,10 @@ interactions: name: Order Amount localIdentifier: dim_1 links: - executionResult: a58e42996ad852ed5bbebabeb0abf642c2443b8d:7bc2dc84d2f66a82ab208d2901c2a55c9f03f383eb669cfbea586ba9f4119a97 + executionResult: 126301ac1374aad1a057c4832924042c597b802d:b3df629b9bfd96c65a578895e6241c4100ac6b1b608b31d4347cd98378bbafd5 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/a58e42996ad852ed5bbebabeb0abf642c2443b8d%3A7bc2dc84d2f66a82ab208d2901c2a55c9f03f383eb669cfbea586ba9f4119a97/metadata + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/126301ac1374aad1a057c4832924042c597b802d%3Ab3df629b9bfd96c65a578895e6241c4100ac6b1b608b31d4347cd98378bbafd5/metadata body: null headers: Accept: @@ -296,7 +296,7 @@ interactions: name: Order Amount localIdentifier: dim_1 links: - executionResult: a58e42996ad852ed5bbebabeb0abf642c2443b8d:7bc2dc84d2f66a82ab208d2901c2a55c9f03f383eb669cfbea586ba9f4119a97 + executionResult: 126301ac1374aad1a057c4832924042c597b802d:b3df629b9bfd96c65a578895e6241c4100ac6b1b608b31d4347cd98378bbafd5 resultSpec: dimensions: - localIdentifier: dim_0 @@ -313,7 +313,7 @@ interactions: resultSize: 4625 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/a58e42996ad852ed5bbebabeb0abf642c2443b8d%3A7bc2dc84d2f66a82ab208d2901c2a55c9f03f383eb669cfbea586ba9f4119a97?offset=0%2C0&limit=100%2C100 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/126301ac1374aad1a057c4832924042c597b802d%3Ab3df629b9bfd96c65a578895e6241c4100ac6b1b608b31d4347cd98378bbafd5?offset=0%2C0&limit=100%2C100 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_one_dim1.yaml b/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_one_dim1.yaml index 397617f38..a44eb7ea3 100644 --- a/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_one_dim1.yaml +++ b/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_one_dim1.yaml @@ -88,7 +88,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 859f441d-b5db-46b2-95a1-fd9fc9dddb14 + - d01321fa-1087-462e-9857-a5df31fffdc6 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -149,10 +149,10 @@ interactions: name: Order Amount localIdentifier: dim_0 links: - executionResult: 853c9684343acf7d19b44d6cf81f37b65e307e85:ab98bc47b4b9f7dd86f74d9e3a593d8782751fe18925fd2b9a0c5014d5cbde86 + executionResult: 9ab85e888f3cb0dcc8febb4af09a33d01f05c4cb:d85de24bc4ba289ccbeac612899c4e03faa8bb8541854bec2c5be80d92bd5c42 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/853c9684343acf7d19b44d6cf81f37b65e307e85%3Aab98bc47b4b9f7dd86f74d9e3a593d8782751fe18925fd2b9a0c5014d5cbde86/metadata + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/9ab85e888f3cb0dcc8febb4af09a33d01f05c4cb%3Ad85de24bc4ba289ccbeac612899c4e03faa8bb8541854bec2c5be80d92bd5c42/metadata body: null headers: Accept: @@ -290,7 +290,7 @@ interactions: name: Order Amount localIdentifier: dim_0 links: - executionResult: 853c9684343acf7d19b44d6cf81f37b65e307e85:ab98bc47b4b9f7dd86f74d9e3a593d8782751fe18925fd2b9a0c5014d5cbde86 + executionResult: 9ab85e888f3cb0dcc8febb4af09a33d01f05c4cb:d85de24bc4ba289ccbeac612899c4e03faa8bb8541854bec2c5be80d92bd5c42 resultSpec: dimensions: - localIdentifier: dim_0 @@ -304,7 +304,7 @@ interactions: resultSize: 2913 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/853c9684343acf7d19b44d6cf81f37b65e307e85%3Aab98bc47b4b9f7dd86f74d9e3a593d8782751fe18925fd2b9a0c5014d5cbde86?offset=0&limit=500 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/9ab85e888f3cb0dcc8febb4af09a33d01f05c4cb%3Ad85de24bc4ba289ccbeac612899c4e03faa8bb8541854bec2c5be80d92bd5c42?offset=0&limit=500 body: null headers: Accept: @@ -4731,7 +4731,7 @@ interactions: dataSourceMessages: [] - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/853c9684343acf7d19b44d6cf81f37b65e307e85%3Aab98bc47b4b9f7dd86f74d9e3a593d8782751fe18925fd2b9a0c5014d5cbde86/metadata + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/9ab85e888f3cb0dcc8febb4af09a33d01f05c4cb%3Ad85de24bc4ba289ccbeac612899c4e03faa8bb8541854bec2c5be80d92bd5c42/metadata body: null headers: Accept: @@ -4869,7 +4869,7 @@ interactions: name: Order Amount localIdentifier: dim_0 links: - executionResult: 853c9684343acf7d19b44d6cf81f37b65e307e85:ab98bc47b4b9f7dd86f74d9e3a593d8782751fe18925fd2b9a0c5014d5cbde86 + executionResult: 9ab85e888f3cb0dcc8febb4af09a33d01f05c4cb:d85de24bc4ba289ccbeac612899c4e03faa8bb8541854bec2c5be80d92bd5c42 resultSpec: dimensions: - localIdentifier: dim_0 @@ -4883,7 +4883,7 @@ interactions: resultSize: 2913 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/853c9684343acf7d19b44d6cf81f37b65e307e85%3Aab98bc47b4b9f7dd86f74d9e3a593d8782751fe18925fd2b9a0c5014d5cbde86?offset=0&limit=500 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/9ab85e888f3cb0dcc8febb4af09a33d01f05c4cb%3Ad85de24bc4ba289ccbeac612899c4e03faa8bb8541854bec2c5be80d92bd5c42?offset=0&limit=500 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_one_dim2.yaml b/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_one_dim2.yaml index 1d68150d6..7ab3465ea 100644 --- a/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_one_dim2.yaml +++ b/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_one_dim2.yaml @@ -90,7 +90,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 5bcf2d10-6e21-44be-9fd2-e4da3fc6f430 + - ad60bee7-72e3-4af2-8bd5-4a072d27a36e X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -153,10 +153,10 @@ interactions: name: Order Amount localIdentifier: dim_1 links: - executionResult: e42cd464dc63cc20ea791420b878e31d59832476:fd234f74c5b18da9f0959460f3f2275b86d1b0e3b10647fdbaf29009c103527d + executionResult: 9adb596e0bd58601902427f5e368e5091e928df5:9b1915b2a3fc6d7759db39e5c673081275a91eb776952a7ee487364cfa174018 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/e42cd464dc63cc20ea791420b878e31d59832476%3Afd234f74c5b18da9f0959460f3f2275b86d1b0e3b10647fdbaf29009c103527d/metadata + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/9adb596e0bd58601902427f5e368e5091e928df5%3A9b1915b2a3fc6d7759db39e5c673081275a91eb776952a7ee487364cfa174018/metadata body: null headers: Accept: @@ -296,7 +296,7 @@ interactions: name: Order Amount localIdentifier: dim_1 links: - executionResult: e42cd464dc63cc20ea791420b878e31d59832476:fd234f74c5b18da9f0959460f3f2275b86d1b0e3b10647fdbaf29009c103527d + executionResult: 9adb596e0bd58601902427f5e368e5091e928df5:9b1915b2a3fc6d7759db39e5c673081275a91eb776952a7ee487364cfa174018 resultSpec: dimensions: - localIdentifier: dim_0 @@ -313,7 +313,7 @@ interactions: resultSize: 2913 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/e42cd464dc63cc20ea791420b878e31d59832476%3Afd234f74c5b18da9f0959460f3f2275b86d1b0e3b10647fdbaf29009c103527d?offset=0%2C0&limit=100%2C100 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/9adb596e0bd58601902427f5e368e5091e928df5%3A9b1915b2a3fc6d7759db39e5c673081275a91eb776952a7ee487364cfa174018?offset=0%2C0&limit=100%2C100 body: null headers: Accept: @@ -1576,7 +1576,7 @@ interactions: dataSourceMessages: [] - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/e42cd464dc63cc20ea791420b878e31d59832476%3Afd234f74c5b18da9f0959460f3f2275b86d1b0e3b10647fdbaf29009c103527d?offset=0%2C100&limit=100%2C100 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/9adb596e0bd58601902427f5e368e5091e928df5%3A9b1915b2a3fc6d7759db39e5c673081275a91eb776952a7ee487364cfa174018?offset=0%2C100&limit=100%2C100 body: null headers: Accept: @@ -2839,7 +2839,7 @@ interactions: dataSourceMessages: [] - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/e42cd464dc63cc20ea791420b878e31d59832476%3Afd234f74c5b18da9f0959460f3f2275b86d1b0e3b10647fdbaf29009c103527d?offset=0%2C200&limit=100%2C100 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/9adb596e0bd58601902427f5e368e5091e928df5%3A9b1915b2a3fc6d7759db39e5c673081275a91eb776952a7ee487364cfa174018?offset=0%2C200&limit=100%2C100 body: null headers: Accept: @@ -4102,7 +4102,7 @@ interactions: dataSourceMessages: [] - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/e42cd464dc63cc20ea791420b878e31d59832476%3Afd234f74c5b18da9f0959460f3f2275b86d1b0e3b10647fdbaf29009c103527d?offset=0%2C300&limit=100%2C100 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/9adb596e0bd58601902427f5e368e5091e928df5%3A9b1915b2a3fc6d7759db39e5c673081275a91eb776952a7ee487364cfa174018?offset=0%2C300&limit=100%2C100 body: null headers: Accept: @@ -4933,7 +4933,7 @@ interactions: dataSourceMessages: [] - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/e42cd464dc63cc20ea791420b878e31d59832476%3Afd234f74c5b18da9f0959460f3f2275b86d1b0e3b10647fdbaf29009c103527d/metadata + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/9adb596e0bd58601902427f5e368e5091e928df5%3A9b1915b2a3fc6d7759db39e5c673081275a91eb776952a7ee487364cfa174018/metadata body: null headers: Accept: @@ -5073,7 +5073,7 @@ interactions: name: Order Amount localIdentifier: dim_1 links: - executionResult: e42cd464dc63cc20ea791420b878e31d59832476:fd234f74c5b18da9f0959460f3f2275b86d1b0e3b10647fdbaf29009c103527d + executionResult: 9adb596e0bd58601902427f5e368e5091e928df5:9b1915b2a3fc6d7759db39e5c673081275a91eb776952a7ee487364cfa174018 resultSpec: dimensions: - localIdentifier: dim_0 @@ -5090,7 +5090,7 @@ interactions: resultSize: 2913 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/e42cd464dc63cc20ea791420b878e31d59832476%3Afd234f74c5b18da9f0959460f3f2275b86d1b0e3b10647fdbaf29009c103527d?offset=0%2C0&limit=100%2C100 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/9adb596e0bd58601902427f5e368e5091e928df5%3A9b1915b2a3fc6d7759db39e5c673081275a91eb776952a7ee487364cfa174018?offset=0%2C0&limit=100%2C100 body: null headers: Accept: @@ -6353,7 +6353,7 @@ interactions: dataSourceMessages: [] - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/e42cd464dc63cc20ea791420b878e31d59832476%3Afd234f74c5b18da9f0959460f3f2275b86d1b0e3b10647fdbaf29009c103527d?offset=0%2C100&limit=100%2C100 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/9adb596e0bd58601902427f5e368e5091e928df5%3A9b1915b2a3fc6d7759db39e5c673081275a91eb776952a7ee487364cfa174018?offset=0%2C100&limit=100%2C100 body: null headers: Accept: @@ -7616,7 +7616,7 @@ interactions: dataSourceMessages: [] - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/e42cd464dc63cc20ea791420b878e31d59832476%3Afd234f74c5b18da9f0959460f3f2275b86d1b0e3b10647fdbaf29009c103527d?offset=0%2C200&limit=100%2C100 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/9adb596e0bd58601902427f5e368e5091e928df5%3A9b1915b2a3fc6d7759db39e5c673081275a91eb776952a7ee487364cfa174018?offset=0%2C200&limit=100%2C100 body: null headers: Accept: @@ -8879,7 +8879,7 @@ interactions: dataSourceMessages: [] - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/e42cd464dc63cc20ea791420b878e31d59832476%3Afd234f74c5b18da9f0959460f3f2275b86d1b0e3b10647fdbaf29009c103527d?offset=0%2C300&limit=100%2C100 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/9adb596e0bd58601902427f5e368e5091e928df5%3A9b1915b2a3fc6d7759db39e5c673081275a91eb776952a7ee487364cfa174018?offset=0%2C300&limit=100%2C100 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_totals1.yaml b/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_totals1.yaml index 7fb773016..eeea9b36d 100644 --- a/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_totals1.yaml +++ b/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_totals1.yaml @@ -109,7 +109,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 922bbb0e-11e7-4677-8b6a-7a4b40f069b9 + - ac9e85ff-0153-4144-9902-e56ed92fa7b5 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -172,10 +172,10 @@ interactions: name: Order Amount localIdentifier: dim_1 links: - executionResult: 99773f89e5757bbf41d338b62c9a044cfd782bfa:11c84507ad904cfeab3ae5d0ca717e2866ba7930260fe0233086a9678daceb2f + executionResult: 7fb3289864e99286f2496365d8d559567b902cb1:aa0ea4a256635827946f5919ab34d7a524df65f0c2439668f78a4975e4da5ae9 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/99773f89e5757bbf41d338b62c9a044cfd782bfa%3A11c84507ad904cfeab3ae5d0ca717e2866ba7930260fe0233086a9678daceb2f/metadata + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/7fb3289864e99286f2496365d8d559567b902cb1%3Aaa0ea4a256635827946f5919ab34d7a524df65f0c2439668f78a4975e4da5ae9/metadata body: null headers: Accept: @@ -315,7 +315,7 @@ interactions: name: Order Amount localIdentifier: dim_1 links: - executionResult: 99773f89e5757bbf41d338b62c9a044cfd782bfa:11c84507ad904cfeab3ae5d0ca717e2866ba7930260fe0233086a9678daceb2f + executionResult: 7fb3289864e99286f2496365d8d559567b902cb1:aa0ea4a256635827946f5919ab34d7a524df65f0c2439668f78a4975e4da5ae9 resultSpec: dimensions: - localIdentifier: dim_0 @@ -350,7 +350,7 @@ interactions: resultSize: 4794 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/99773f89e5757bbf41d338b62c9a044cfd782bfa%3A11c84507ad904cfeab3ae5d0ca717e2866ba7930260fe0233086a9678daceb2f?offset=0%2C0&limit=100%2C100 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/7fb3289864e99286f2496365d8d559567b902cb1%3Aaa0ea4a256635827946f5919ab34d7a524df65f0c2439668f78a4975e4da5ae9?offset=0%2C0&limit=100%2C100 body: null headers: Accept: @@ -1779,7 +1779,7 @@ interactions: dataSourceMessages: [] - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/99773f89e5757bbf41d338b62c9a044cfd782bfa%3A11c84507ad904cfeab3ae5d0ca717e2866ba7930260fe0233086a9678daceb2f/metadata + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/7fb3289864e99286f2496365d8d559567b902cb1%3Aaa0ea4a256635827946f5919ab34d7a524df65f0c2439668f78a4975e4da5ae9/metadata body: null headers: Accept: @@ -1919,7 +1919,7 @@ interactions: name: Order Amount localIdentifier: dim_1 links: - executionResult: 99773f89e5757bbf41d338b62c9a044cfd782bfa:11c84507ad904cfeab3ae5d0ca717e2866ba7930260fe0233086a9678daceb2f + executionResult: 7fb3289864e99286f2496365d8d559567b902cb1:aa0ea4a256635827946f5919ab34d7a524df65f0c2439668f78a4975e4da5ae9 resultSpec: dimensions: - localIdentifier: dim_0 @@ -1954,7 +1954,7 @@ interactions: resultSize: 4794 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/99773f89e5757bbf41d338b62c9a044cfd782bfa%3A11c84507ad904cfeab3ae5d0ca717e2866ba7930260fe0233086a9678daceb2f?offset=0%2C0&limit=100%2C100 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/7fb3289864e99286f2496365d8d559567b902cb1%3Aaa0ea4a256635827946f5919ab34d7a524df65f0c2439668f78a4975e4da5ae9?offset=0%2C0&limit=100%2C100 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_totals2.yaml b/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_totals2.yaml index 503003908..3be9f7d63 100644 --- a/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_totals2.yaml +++ b/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_totals2.yaml @@ -107,7 +107,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 11deaf84-8e9e-49c6-85e0-0e808bd9967f + - 8d75f9de-cca0-4bf9-b1ef-7e7044afd37c X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -170,10 +170,10 @@ interactions: name: Order Amount localIdentifier: dim_1 links: - executionResult: 901ffa2a69753aaa37fb5c647e14db19be78465d:e5a7b7b1b6b741154530a1879eca83011355583eb59a9b265d703184e04acc1d + executionResult: 9ad039cddde5093ef0b94a4de544913d62c2a5eb:3abac46d99a69b8d7f695cc67fe665899b84f3962e7e17c8f5d6eaae2d05f0f4 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/901ffa2a69753aaa37fb5c647e14db19be78465d%3Ae5a7b7b1b6b741154530a1879eca83011355583eb59a9b265d703184e04acc1d/metadata + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/9ad039cddde5093ef0b94a4de544913d62c2a5eb%3A3abac46d99a69b8d7f695cc67fe665899b84f3962e7e17c8f5d6eaae2d05f0f4/metadata body: null headers: Accept: @@ -313,7 +313,7 @@ interactions: name: Order Amount localIdentifier: dim_1 links: - executionResult: 901ffa2a69753aaa37fb5c647e14db19be78465d:e5a7b7b1b6b741154530a1879eca83011355583eb59a9b265d703184e04acc1d + executionResult: 9ad039cddde5093ef0b94a4de544913d62c2a5eb:3abac46d99a69b8d7f695cc67fe665899b84f3962e7e17c8f5d6eaae2d05f0f4 resultSpec: dimensions: - localIdentifier: dim_0 @@ -346,7 +346,7 @@ interactions: resultSize: 15444 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/901ffa2a69753aaa37fb5c647e14db19be78465d%3Ae5a7b7b1b6b741154530a1879eca83011355583eb59a9b265d703184e04acc1d?offset=0%2C0&limit=100%2C100 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/9ad039cddde5093ef0b94a4de544913d62c2a5eb%3A3abac46d99a69b8d7f695cc67fe665899b84f3962e7e17c8f5d6eaae2d05f0f4?offset=0%2C0&limit=100%2C100 body: null headers: Accept: @@ -2830,7 +2830,7 @@ interactions: dataSourceMessages: [] - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/901ffa2a69753aaa37fb5c647e14db19be78465d%3Ae5a7b7b1b6b741154530a1879eca83011355583eb59a9b265d703184e04acc1d/metadata + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/9ad039cddde5093ef0b94a4de544913d62c2a5eb%3A3abac46d99a69b8d7f695cc67fe665899b84f3962e7e17c8f5d6eaae2d05f0f4/metadata body: null headers: Accept: @@ -2970,7 +2970,7 @@ interactions: name: Order Amount localIdentifier: dim_1 links: - executionResult: 901ffa2a69753aaa37fb5c647e14db19be78465d:e5a7b7b1b6b741154530a1879eca83011355583eb59a9b265d703184e04acc1d + executionResult: 9ad039cddde5093ef0b94a4de544913d62c2a5eb:3abac46d99a69b8d7f695cc67fe665899b84f3962e7e17c8f5d6eaae2d05f0f4 resultSpec: dimensions: - localIdentifier: dim_0 @@ -3003,7 +3003,7 @@ interactions: resultSize: 15444 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/901ffa2a69753aaa37fb5c647e14db19be78465d%3Ae5a7b7b1b6b741154530a1879eca83011355583eb59a9b265d703184e04acc1d?offset=0%2C0&limit=100%2C100 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/9ad039cddde5093ef0b94a4de544913d62c2a5eb%3A3abac46d99a69b8d7f695cc67fe665899b84f3962e7e17c8f5d6eaae2d05f0f4?offset=0%2C0&limit=100%2C100 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_totals3.yaml b/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_totals3.yaml index 6c9ee3100..6c0944eb2 100644 --- a/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_totals3.yaml +++ b/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_totals3.yaml @@ -109,7 +109,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 2adb330b-96d8-40f9-a357-7f9ca2350258 + - 5210cad3-74cb-4f47-b387-c0d3605aa827 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -172,10 +172,10 @@ interactions: valueType: TEXT localIdentifier: dim_1 links: - executionResult: 8175f07102499cf6f056031acaa08eb0492ee4db:ab8464ba1f8bbb5d30bc54feb0d49fc84bc7babd3452f2756ec05a49b173cfa8 + executionResult: a3b1dc166f39cc427599afd8d195af2cafce9b88:8df4e780064c49a9279cffc77d054a004dde43db389044aa90e652ee21b617af - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/8175f07102499cf6f056031acaa08eb0492ee4db%3Aab8464ba1f8bbb5d30bc54feb0d49fc84bc7babd3452f2756ec05a49b173cfa8/metadata + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/a3b1dc166f39cc427599afd8d195af2cafce9b88%3A8df4e780064c49a9279cffc77d054a004dde43db389044aa90e652ee21b617af/metadata body: null headers: Accept: @@ -315,7 +315,7 @@ interactions: valueType: TEXT localIdentifier: dim_1 links: - executionResult: 8175f07102499cf6f056031acaa08eb0492ee4db:ab8464ba1f8bbb5d30bc54feb0d49fc84bc7babd3452f2756ec05a49b173cfa8 + executionResult: a3b1dc166f39cc427599afd8d195af2cafce9b88:8df4e780064c49a9279cffc77d054a004dde43db389044aa90e652ee21b617af resultSpec: dimensions: - localIdentifier: dim_0 @@ -350,7 +350,7 @@ interactions: resultSize: 4794 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/8175f07102499cf6f056031acaa08eb0492ee4db%3Aab8464ba1f8bbb5d30bc54feb0d49fc84bc7babd3452f2756ec05a49b173cfa8?offset=0%2C0&limit=100%2C100 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/a3b1dc166f39cc427599afd8d195af2cafce9b88%3A8df4e780064c49a9279cffc77d054a004dde43db389044aa90e652ee21b617af?offset=0%2C0&limit=100%2C100 body: null headers: Accept: @@ -1779,7 +1779,7 @@ interactions: dataSourceMessages: [] - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/8175f07102499cf6f056031acaa08eb0492ee4db%3Aab8464ba1f8bbb5d30bc54feb0d49fc84bc7babd3452f2756ec05a49b173cfa8/metadata + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/a3b1dc166f39cc427599afd8d195af2cafce9b88%3A8df4e780064c49a9279cffc77d054a004dde43db389044aa90e652ee21b617af/metadata body: null headers: Accept: @@ -1919,7 +1919,7 @@ interactions: valueType: TEXT localIdentifier: dim_1 links: - executionResult: 8175f07102499cf6f056031acaa08eb0492ee4db:ab8464ba1f8bbb5d30bc54feb0d49fc84bc7babd3452f2756ec05a49b173cfa8 + executionResult: a3b1dc166f39cc427599afd8d195af2cafce9b88:8df4e780064c49a9279cffc77d054a004dde43db389044aa90e652ee21b617af resultSpec: dimensions: - localIdentifier: dim_0 @@ -1954,7 +1954,7 @@ interactions: resultSize: 4794 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/8175f07102499cf6f056031acaa08eb0492ee4db%3Aab8464ba1f8bbb5d30bc54feb0d49fc84bc7babd3452f2756ec05a49b173cfa8?offset=0%2C0&limit=100%2C100 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/a3b1dc166f39cc427599afd8d195af2cafce9b88%3A8df4e780064c49a9279cffc77d054a004dde43db389044aa90e652ee21b617af?offset=0%2C0&limit=100%2C100 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_totals4.yaml b/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_totals4.yaml index 5a17d2d6a..4ef65048a 100644 --- a/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_totals4.yaml +++ b/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_totals4.yaml @@ -107,7 +107,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 7086a7e1-b6db-4b3d-a6e8-788dcd147eb2 + - c2ac4ee1-1443-41b1-900d-33930767f430 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -170,10 +170,10 @@ interactions: valueType: TEXT localIdentifier: dim_1 links: - executionResult: b0dc8ec8850e250fbc82155b330f6079221748e1:2c363816a90864fd4bed15d36a094a7d7e24c32a4affe9a7e7a27cd008da8a40 + executionResult: e18cf8538871bbc9a51eb92bcd96af418be2a6df:742d553b232002ca6ef5121eacb12d0a2222e776c9a1563a8dd0a283007cf328 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/b0dc8ec8850e250fbc82155b330f6079221748e1%3A2c363816a90864fd4bed15d36a094a7d7e24c32a4affe9a7e7a27cd008da8a40/metadata + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/e18cf8538871bbc9a51eb92bcd96af418be2a6df%3A742d553b232002ca6ef5121eacb12d0a2222e776c9a1563a8dd0a283007cf328/metadata body: null headers: Accept: @@ -313,7 +313,7 @@ interactions: valueType: TEXT localIdentifier: dim_1 links: - executionResult: b0dc8ec8850e250fbc82155b330f6079221748e1:2c363816a90864fd4bed15d36a094a7d7e24c32a4affe9a7e7a27cd008da8a40 + executionResult: e18cf8538871bbc9a51eb92bcd96af418be2a6df:742d553b232002ca6ef5121eacb12d0a2222e776c9a1563a8dd0a283007cf328 resultSpec: dimensions: - localIdentifier: dim_0 @@ -346,7 +346,7 @@ interactions: resultSize: 15444 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/b0dc8ec8850e250fbc82155b330f6079221748e1%3A2c363816a90864fd4bed15d36a094a7d7e24c32a4affe9a7e7a27cd008da8a40?offset=0%2C0&limit=100%2C100 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/e18cf8538871bbc9a51eb92bcd96af418be2a6df%3A742d553b232002ca6ef5121eacb12d0a2222e776c9a1563a8dd0a283007cf328?offset=0%2C0&limit=100%2C100 body: null headers: Accept: @@ -2830,7 +2830,7 @@ interactions: dataSourceMessages: [] - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/b0dc8ec8850e250fbc82155b330f6079221748e1%3A2c363816a90864fd4bed15d36a094a7d7e24c32a4affe9a7e7a27cd008da8a40/metadata + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/e18cf8538871bbc9a51eb92bcd96af418be2a6df%3A742d553b232002ca6ef5121eacb12d0a2222e776c9a1563a8dd0a283007cf328/metadata body: null headers: Accept: @@ -2970,7 +2970,7 @@ interactions: valueType: TEXT localIdentifier: dim_1 links: - executionResult: b0dc8ec8850e250fbc82155b330f6079221748e1:2c363816a90864fd4bed15d36a094a7d7e24c32a4affe9a7e7a27cd008da8a40 + executionResult: e18cf8538871bbc9a51eb92bcd96af418be2a6df:742d553b232002ca6ef5121eacb12d0a2222e776c9a1563a8dd0a283007cf328 resultSpec: dimensions: - localIdentifier: dim_0 @@ -3003,7 +3003,7 @@ interactions: resultSize: 15444 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/b0dc8ec8850e250fbc82155b330f6079221748e1%3A2c363816a90864fd4bed15d36a094a7d7e24c32a4affe9a7e7a27cd008da8a40?offset=0%2C0&limit=100%2C100 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/e18cf8538871bbc9a51eb92bcd96af418be2a6df%3A742d553b232002ca6ef5121eacb12d0a2222e776c9a1563a8dd0a283007cf328?offset=0%2C0&limit=100%2C100 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_two_dim1.yaml b/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_two_dim1.yaml index 9811dddf1..e1b514ea8 100644 --- a/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_two_dim1.yaml +++ b/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_two_dim1.yaml @@ -90,7 +90,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 277b2a32-acff-4b80-adbd-6d09493d99c2 + - d0cb10c1-95bf-4175-8d1a-d2dcfa7db2b8 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -153,10 +153,10 @@ interactions: name: Order Amount localIdentifier: dim_1 links: - executionResult: a58e42996ad852ed5bbebabeb0abf642c2443b8d:7bc2dc84d2f66a82ab208d2901c2a55c9f03f383eb669cfbea586ba9f4119a97 + executionResult: 126301ac1374aad1a057c4832924042c597b802d:b3df629b9bfd96c65a578895e6241c4100ac6b1b608b31d4347cd98378bbafd5 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/a58e42996ad852ed5bbebabeb0abf642c2443b8d%3A7bc2dc84d2f66a82ab208d2901c2a55c9f03f383eb669cfbea586ba9f4119a97/metadata + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/126301ac1374aad1a057c4832924042c597b802d%3Ab3df629b9bfd96c65a578895e6241c4100ac6b1b608b31d4347cd98378bbafd5/metadata body: null headers: Accept: @@ -296,7 +296,7 @@ interactions: name: Order Amount localIdentifier: dim_1 links: - executionResult: a58e42996ad852ed5bbebabeb0abf642c2443b8d:7bc2dc84d2f66a82ab208d2901c2a55c9f03f383eb669cfbea586ba9f4119a97 + executionResult: 126301ac1374aad1a057c4832924042c597b802d:b3df629b9bfd96c65a578895e6241c4100ac6b1b608b31d4347cd98378bbafd5 resultSpec: dimensions: - localIdentifier: dim_0 @@ -313,7 +313,7 @@ interactions: resultSize: 4625 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/a58e42996ad852ed5bbebabeb0abf642c2443b8d%3A7bc2dc84d2f66a82ab208d2901c2a55c9f03f383eb669cfbea586ba9f4119a97?offset=0%2C0&limit=100%2C100 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/126301ac1374aad1a057c4832924042c597b802d%3Ab3df629b9bfd96c65a578895e6241c4100ac6b1b608b31d4347cd98378bbafd5?offset=0%2C0&limit=100%2C100 body: null headers: Accept: @@ -1088,7 +1088,7 @@ interactions: dataSourceMessages: [] - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/a58e42996ad852ed5bbebabeb0abf642c2443b8d%3A7bc2dc84d2f66a82ab208d2901c2a55c9f03f383eb669cfbea586ba9f4119a97/metadata + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/126301ac1374aad1a057c4832924042c597b802d%3Ab3df629b9bfd96c65a578895e6241c4100ac6b1b608b31d4347cd98378bbafd5/metadata body: null headers: Accept: @@ -1228,7 +1228,7 @@ interactions: name: Order Amount localIdentifier: dim_1 links: - executionResult: a58e42996ad852ed5bbebabeb0abf642c2443b8d:7bc2dc84d2f66a82ab208d2901c2a55c9f03f383eb669cfbea586ba9f4119a97 + executionResult: 126301ac1374aad1a057c4832924042c597b802d:b3df629b9bfd96c65a578895e6241c4100ac6b1b608b31d4347cd98378bbafd5 resultSpec: dimensions: - localIdentifier: dim_0 @@ -1245,7 +1245,7 @@ interactions: resultSize: 4625 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/a58e42996ad852ed5bbebabeb0abf642c2443b8d%3A7bc2dc84d2f66a82ab208d2901c2a55c9f03f383eb669cfbea586ba9f4119a97?offset=0%2C0&limit=100%2C100 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/126301ac1374aad1a057c4832924042c597b802d%3Ab3df629b9bfd96c65a578895e6241c4100ac6b1b608b31d4347cd98378bbafd5?offset=0%2C0&limit=100%2C100 body: null headers: Accept: @@ -2020,7 +2020,7 @@ interactions: dataSourceMessages: [] - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/a58e42996ad852ed5bbebabeb0abf642c2443b8d%3A7bc2dc84d2f66a82ab208d2901c2a55c9f03f383eb669cfbea586ba9f4119a97/metadata + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/126301ac1374aad1a057c4832924042c597b802d%3Ab3df629b9bfd96c65a578895e6241c4100ac6b1b608b31d4347cd98378bbafd5/metadata body: null headers: Accept: @@ -2160,7 +2160,7 @@ interactions: name: Order Amount localIdentifier: dim_1 links: - executionResult: a58e42996ad852ed5bbebabeb0abf642c2443b8d:7bc2dc84d2f66a82ab208d2901c2a55c9f03f383eb669cfbea586ba9f4119a97 + executionResult: 126301ac1374aad1a057c4832924042c597b802d:b3df629b9bfd96c65a578895e6241c4100ac6b1b608b31d4347cd98378bbafd5 resultSpec: dimensions: - localIdentifier: dim_0 @@ -2177,7 +2177,7 @@ interactions: resultSize: 4625 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/a58e42996ad852ed5bbebabeb0abf642c2443b8d%3A7bc2dc84d2f66a82ab208d2901c2a55c9f03f383eb669cfbea586ba9f4119a97?offset=0%2C0&limit=100%2C100 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/126301ac1374aad1a057c4832924042c597b802d%3Ab3df629b9bfd96c65a578895e6241c4100ac6b1b608b31d4347cd98378bbafd5?offset=0%2C0&limit=100%2C100 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_two_dim2.yaml b/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_two_dim2.yaml index bef0f1460..c012d5fd7 100644 --- a/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_two_dim2.yaml +++ b/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_two_dim2.yaml @@ -90,7 +90,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - eb22157e-f0ca-4e54-8111-1b2529a19647 + - 9f037977-446c-488b-8112-d3a5e3c83211 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -153,10 +153,10 @@ interactions: name: Order Amount localIdentifier: dim_1 links: - executionResult: 01b0c77e83fe45ddb9115fa2b91be41ddde9e713:f633cc7745be68ed66746d22ed89582de5ae697ce1abfe65fc89fb1018d97c8f + executionResult: 3aab4bf56619eaa23ab275ab638ea14ca878130d:5cbe77850897d439c7b58c69ad39449957f6e1f3011add86e49c869bc232aacf - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/01b0c77e83fe45ddb9115fa2b91be41ddde9e713%3Af633cc7745be68ed66746d22ed89582de5ae697ce1abfe65fc89fb1018d97c8f/metadata + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/3aab4bf56619eaa23ab275ab638ea14ca878130d%3A5cbe77850897d439c7b58c69ad39449957f6e1f3011add86e49c869bc232aacf/metadata body: null headers: Accept: @@ -296,7 +296,7 @@ interactions: name: Order Amount localIdentifier: dim_1 links: - executionResult: 01b0c77e83fe45ddb9115fa2b91be41ddde9e713:f633cc7745be68ed66746d22ed89582de5ae697ce1abfe65fc89fb1018d97c8f + executionResult: 3aab4bf56619eaa23ab275ab638ea14ca878130d:5cbe77850897d439c7b58c69ad39449957f6e1f3011add86e49c869bc232aacf resultSpec: dimensions: - localIdentifier: dim_0 @@ -313,7 +313,7 @@ interactions: resultSize: 11457 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/01b0c77e83fe45ddb9115fa2b91be41ddde9e713%3Af633cc7745be68ed66746d22ed89582de5ae697ce1abfe65fc89fb1018d97c8f?offset=0%2C0&limit=100%2C100 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/3aab4bf56619eaa23ab275ab638ea14ca878130d%3A5cbe77850897d439c7b58c69ad39449957f6e1f3011add86e49c869bc232aacf?offset=0%2C0&limit=100%2C100 body: null headers: Accept: @@ -1480,7 +1480,7 @@ interactions: dataSourceMessages: [] - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/01b0c77e83fe45ddb9115fa2b91be41ddde9e713%3Af633cc7745be68ed66746d22ed89582de5ae697ce1abfe65fc89fb1018d97c8f?offset=100%2C0&limit=100%2C100 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/3aab4bf56619eaa23ab275ab638ea14ca878130d%3A5cbe77850897d439c7b58c69ad39449957f6e1f3011add86e49c869bc232aacf?offset=100%2C0&limit=100%2C100 body: null headers: Accept: @@ -2449,7 +2449,7 @@ interactions: dataSourceMessages: [] - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/01b0c77e83fe45ddb9115fa2b91be41ddde9e713%3Af633cc7745be68ed66746d22ed89582de5ae697ce1abfe65fc89fb1018d97c8f/metadata + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/3aab4bf56619eaa23ab275ab638ea14ca878130d%3A5cbe77850897d439c7b58c69ad39449957f6e1f3011add86e49c869bc232aacf/metadata body: null headers: Accept: @@ -2589,7 +2589,7 @@ interactions: name: Order Amount localIdentifier: dim_1 links: - executionResult: 01b0c77e83fe45ddb9115fa2b91be41ddde9e713:f633cc7745be68ed66746d22ed89582de5ae697ce1abfe65fc89fb1018d97c8f + executionResult: 3aab4bf56619eaa23ab275ab638ea14ca878130d:5cbe77850897d439c7b58c69ad39449957f6e1f3011add86e49c869bc232aacf resultSpec: dimensions: - localIdentifier: dim_0 @@ -2606,7 +2606,7 @@ interactions: resultSize: 11457 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/01b0c77e83fe45ddb9115fa2b91be41ddde9e713%3Af633cc7745be68ed66746d22ed89582de5ae697ce1abfe65fc89fb1018d97c8f?offset=0%2C0&limit=100%2C100 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/3aab4bf56619eaa23ab275ab638ea14ca878130d%3A5cbe77850897d439c7b58c69ad39449957f6e1f3011add86e49c869bc232aacf?offset=0%2C0&limit=100%2C100 body: null headers: Accept: @@ -3773,7 +3773,7 @@ interactions: dataSourceMessages: [] - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/01b0c77e83fe45ddb9115fa2b91be41ddde9e713%3Af633cc7745be68ed66746d22ed89582de5ae697ce1abfe65fc89fb1018d97c8f?offset=100%2C0&limit=100%2C100 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/3aab4bf56619eaa23ab275ab638ea14ca878130d%3A5cbe77850897d439c7b58c69ad39449957f6e1f3011add86e49c869bc232aacf?offset=100%2C0&limit=100%2C100 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_two_dim3.yaml b/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_two_dim3.yaml index 8afe6b94f..ec6a8ae16 100644 --- a/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_two_dim3.yaml +++ b/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_exec_def_two_dim3.yaml @@ -90,7 +90,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - fb5d67fc-f097-4555-bf29-021f674b57b4 + - 70b0dc2a-9008-4fda-a4a4-15f5fa8b0ae2 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -153,10 +153,10 @@ interactions: name: Order Amount localIdentifier: dim_1 links: - executionResult: 1803223956303b86bb97fcdfac8b36a01dc2037e:d7b076d14a1ea796d3be2af902ac3235ff9ff5f0253b95329e8408eb427701a3 + executionResult: a896750afbb4b02b1427a5443b78234121ee5731:2eb016e5301806bf69d2c3a6e63bd877a2701f55da8654ddc303b01a8a488dc8 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/1803223956303b86bb97fcdfac8b36a01dc2037e%3Ad7b076d14a1ea796d3be2af902ac3235ff9ff5f0253b95329e8408eb427701a3/metadata + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/a896750afbb4b02b1427a5443b78234121ee5731%3A2eb016e5301806bf69d2c3a6e63bd877a2701f55da8654ddc303b01a8a488dc8/metadata body: null headers: Accept: @@ -296,7 +296,7 @@ interactions: name: Order Amount localIdentifier: dim_1 links: - executionResult: 1803223956303b86bb97fcdfac8b36a01dc2037e:d7b076d14a1ea796d3be2af902ac3235ff9ff5f0253b95329e8408eb427701a3 + executionResult: a896750afbb4b02b1427a5443b78234121ee5731:2eb016e5301806bf69d2c3a6e63bd877a2701f55da8654ddc303b01a8a488dc8 resultSpec: dimensions: - localIdentifier: dim_0 @@ -313,7 +313,7 @@ interactions: resultSize: 3152 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/1803223956303b86bb97fcdfac8b36a01dc2037e%3Ad7b076d14a1ea796d3be2af902ac3235ff9ff5f0253b95329e8408eb427701a3?offset=0%2C0&limit=100%2C100 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/a896750afbb4b02b1427a5443b78234121ee5731%3A2eb016e5301806bf69d2c3a6e63bd877a2701f55da8654ddc303b01a8a488dc8?offset=0%2C0&limit=100%2C100 body: null headers: Accept: @@ -1540,7 +1540,7 @@ interactions: dataSourceMessages: [] - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/1803223956303b86bb97fcdfac8b36a01dc2037e%3Ad7b076d14a1ea796d3be2af902ac3235ff9ff5f0253b95329e8408eb427701a3/metadata + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/a896750afbb4b02b1427a5443b78234121ee5731%3A2eb016e5301806bf69d2c3a6e63bd877a2701f55da8654ddc303b01a8a488dc8/metadata body: null headers: Accept: @@ -1680,7 +1680,7 @@ interactions: name: Order Amount localIdentifier: dim_1 links: - executionResult: 1803223956303b86bb97fcdfac8b36a01dc2037e:d7b076d14a1ea796d3be2af902ac3235ff9ff5f0253b95329e8408eb427701a3 + executionResult: a896750afbb4b02b1427a5443b78234121ee5731:2eb016e5301806bf69d2c3a6e63bd877a2701f55da8654ddc303b01a8a488dc8 resultSpec: dimensions: - localIdentifier: dim_0 @@ -1697,7 +1697,7 @@ interactions: resultSize: 3152 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/1803223956303b86bb97fcdfac8b36a01dc2037e%3Ad7b076d14a1ea796d3be2af902ac3235ff9ff5f0253b95329e8408eb427701a3?offset=0%2C0&limit=100%2C100 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/a896750afbb4b02b1427a5443b78234121ee5731%3A2eb016e5301806bf69d2c3a6e63bd877a2701f55da8654ddc303b01a8a488dc8?offset=0%2C0&limit=100%2C100 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_items.yaml b/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_items.yaml index fa23ced62..201b840c8 100644 --- a/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_items.yaml +++ b/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_items.yaml @@ -84,7 +84,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - e48d1f50-2a7d-4f67-820f-bfd4532c650c + - 698f07d5-79d2-4d86-b785-678ff2747555 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -132,7 +132,7 @@ interactions: valueType: TEXT localIdentifier: dim_1 links: - executionResult: 923761578d543993b2847eed7de4dbcc1173797b:2129061f5b039850fe3e329cdfa0af80268555f4b8c62cda50f33cd6cba12a52 + executionResult: 80379dce6c4f18244ffd34234bcebd5c908c37ec:cc182b9863dafb1ca2b7de017bd246346d73ad6140ed533d2c2ec816c5e424f6 - request: method: GET uri: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28region%2Cproducts.category%29&page=0&size=500 @@ -296,7 +296,7 @@ interactions: next: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28%27region%27%2C%27products.category%27%29&page=1&size=500 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/923761578d543993b2847eed7de4dbcc1173797b%3A2129061f5b039850fe3e329cdfa0af80268555f4b8c62cda50f33cd6cba12a52?offset=0%2C0&limit=2%2C1000 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/80379dce6c4f18244ffd34234bcebd5c908c37ec%3Acc182b9863dafb1ca2b7de017bd246346d73ad6140ed533d2c2ec816c5e424f6?offset=0%2C0&limit=2%2C1000 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_items_no_index.yaml b/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_items_no_index.yaml index b63b19c28..bfe0cda61 100644 --- a/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_items_no_index.yaml +++ b/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_items_no_index.yaml @@ -84,7 +84,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - b69376ce-ed14-4573-9e60-6723c860412d + - fadab66d-7c6b-41f0-8c89-50ba15067ceb X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -132,7 +132,7 @@ interactions: valueType: TEXT localIdentifier: dim_1 links: - executionResult: 923761578d543993b2847eed7de4dbcc1173797b:2129061f5b039850fe3e329cdfa0af80268555f4b8c62cda50f33cd6cba12a52 + executionResult: 80379dce6c4f18244ffd34234bcebd5c908c37ec:cc182b9863dafb1ca2b7de017bd246346d73ad6140ed533d2c2ec816c5e424f6 - request: method: GET uri: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28region%2Cproducts.category%29&page=0&size=500 @@ -296,7 +296,7 @@ interactions: next: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28%27region%27%2C%27products.category%27%29&page=1&size=500 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/923761578d543993b2847eed7de4dbcc1173797b%3A2129061f5b039850fe3e329cdfa0af80268555f4b8c62cda50f33cd6cba12a52?offset=0%2C0&limit=2%2C1000 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/80379dce6c4f18244ffd34234bcebd5c908c37ec%3Acc182b9863dafb1ca2b7de017bd246346d73ad6140ed533d2c2ec816c5e424f6?offset=0%2C0&limit=2%2C1000 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_visualization.yaml b/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_visualization.yaml index f0665bb1c..b3afbb08d 100644 --- a/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_visualization.yaml +++ b/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_visualization.yaml @@ -371,7 +371,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 6d3c4266-5d36-46b1-8ac7-23e47aa50423 + - 1256593e-da9f-48fb-8ba4-2dd46cb2955d X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -423,7 +423,7 @@ interactions: valueType: TEXT localIdentifier: dim_1 links: - executionResult: c130be01b1d5c2f25c042b4e04e131c864798076:82b80771dfe86f95839b57306887fc90ffdf490e64bd6ffcdbd6d8791e978dc5 + executionResult: ea2a9fe9b5b0852951cc600526b313475e254262:0f982a35059b9db86c770bbeab12cd3dd5884c9e6a55ccf8b4cf4fb214f38af7 - request: method: GET uri: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28products.category%2Cproduct_name%29&page=0&size=500 @@ -570,7 +570,7 @@ interactions: next: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28%27products.category%27%2C%27product_name%27%29&page=1&size=500 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/c130be01b1d5c2f25c042b4e04e131c864798076%3A82b80771dfe86f95839b57306887fc90ffdf490e64bd6ffcdbd6d8791e978dc5?offset=0%2C0&limit=4%2C1000 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/ea2a9fe9b5b0852951cc600526b313475e254262%3A0f982a35059b9db86c770bbeab12cd3dd5884c9e6a55ccf8b4cf4fb214f38af7?offset=0%2C0&limit=4%2C1000 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_visualization_date.yaml b/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_visualization_date.yaml index 8d8805da6..4aa7ee27c 100644 --- a/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_visualization_date.yaml +++ b/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_visualization_date.yaml @@ -276,7 +276,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - e0845448-197d-4195-975c-23f9de9ef662 + - cec417b4-de64-4f60-817b-668bb3018722 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -315,7 +315,7 @@ interactions: valueType: TEXT localIdentifier: dim_1 links: - executionResult: b95be2a206a16d9af22bf417dd2be1092b585a13:96a62de88fa605a98b71dbef07d187ae7dc606f211e8c384e2ff2492741c6a4e + executionResult: 6d5b6ed053e83e0f3075e69619322fe0a19129fd:aecafc6f9cc2bc7265af2aca19172e0639e02e413ce19e66a931d04f5ef8043e - request: method: GET uri: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28date.month%29&page=0&size=500 @@ -410,7 +410,7 @@ interactions: next: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3D%3D%27date.month%27&page=1&size=500 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/b95be2a206a16d9af22bf417dd2be1092b585a13%3A96a62de88fa605a98b71dbef07d187ae7dc606f211e8c384e2ff2492741c6a4e?offset=0%2C0&limit=2%2C1000 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/6d5b6ed053e83e0f3075e69619322fe0a19129fd%3Aaecafc6f9cc2bc7265af2aca19172e0639e02e413ce19e66a931d04f5ef8043e?offset=0%2C0&limit=2%2C1000 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_visualization_no_index.yaml b/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_visualization_no_index.yaml index 5ae6ae42a..b77aa001e 100644 --- a/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_visualization_no_index.yaml +++ b/packages/gooddata-pandas/tests/dataframe/fixtures/dataframe_for_visualization_no_index.yaml @@ -371,7 +371,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 3baa0e2b-c84f-4add-88bd-e0f078b47de3 + - f87f3246-0f4f-4524-b229-036feec46141 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -423,7 +423,7 @@ interactions: valueType: TEXT localIdentifier: dim_1 links: - executionResult: c130be01b1d5c2f25c042b4e04e131c864798076:82b80771dfe86f95839b57306887fc90ffdf490e64bd6ffcdbd6d8791e978dc5 + executionResult: ea2a9fe9b5b0852951cc600526b313475e254262:0f982a35059b9db86c770bbeab12cd3dd5884c9e6a55ccf8b4cf4fb214f38af7 - request: method: GET uri: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28products.category%2Cproduct_name%29&page=0&size=500 @@ -570,7 +570,7 @@ interactions: next: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28%27products.category%27%2C%27product_name%27%29&page=1&size=500 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/c130be01b1d5c2f25c042b4e04e131c864798076%3A82b80771dfe86f95839b57306887fc90ffdf490e64bd6ffcdbd6d8791e978dc5?offset=0%2C0&limit=4%2C1000 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/ea2a9fe9b5b0852951cc600526b313475e254262%3A0f982a35059b9db86c770bbeab12cd3dd5884c9e6a55ccf8b4cf4fb214f38af7?offset=0%2C0&limit=4%2C1000 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/dataframe/fixtures/empty_indexed_dataframe.yaml b/packages/gooddata-pandas/tests/dataframe/fixtures/empty_indexed_dataframe.yaml index 09845237b..d0c150957 100644 --- a/packages/gooddata-pandas/tests/dataframe/fixtures/empty_indexed_dataframe.yaml +++ b/packages/gooddata-pandas/tests/dataframe/fixtures/empty_indexed_dataframe.yaml @@ -77,7 +77,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - e68b9f97-f1b2-4a3c-b269-b004fb242d21 + - 53743ba4-05bb-4513-b708-7aeeaec9dbd4 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -112,7 +112,7 @@ interactions: valueType: TEXT localIdentifier: dim_1 links: - executionResult: 6fd1934de884a9b6f4c0a5b00c17a4fcb0e83aa7:d10aa74a9819e440efdcf671e7b9d4c8bcdcb28c5009a3360c87c774c5d7a535 + executionResult: 442cc52072588b97d87b1bacc422d04d03b0180d:5db10c189567153906e7a351c9154e1256809a40872255708674a695c0643fb6 - request: method: GET uri: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28product_name%29&page=0&size=500 @@ -219,7 +219,7 @@ interactions: next: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3D%3D%27product_name%27&page=1&size=500 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/6fd1934de884a9b6f4c0a5b00c17a4fcb0e83aa7%3Ad10aa74a9819e440efdcf671e7b9d4c8bcdcb28c5009a3360c87c774c5d7a535?offset=0%2C0&limit=2%2C1000 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/442cc52072588b97d87b1bacc422d04d03b0180d%3A5db10c189567153906e7a351c9154e1256809a40872255708674a695c0643fb6?offset=0%2C0&limit=2%2C1000 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/dataframe/fixtures/empty_not_indexed_dataframe.yaml b/packages/gooddata-pandas/tests/dataframe/fixtures/empty_not_indexed_dataframe.yaml index b948cc410..0cc8b38e0 100644 --- a/packages/gooddata-pandas/tests/dataframe/fixtures/empty_not_indexed_dataframe.yaml +++ b/packages/gooddata-pandas/tests/dataframe/fixtures/empty_not_indexed_dataframe.yaml @@ -77,7 +77,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 1783fc4f-a9a9-422d-942f-0a56161b14e4 + - 0e76092f-c078-4ae5-868c-674a72393380 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -112,7 +112,7 @@ interactions: valueType: TEXT localIdentifier: dim_1 links: - executionResult: 6fd1934de884a9b6f4c0a5b00c17a4fcb0e83aa7:d10aa74a9819e440efdcf671e7b9d4c8bcdcb28c5009a3360c87c774c5d7a535 + executionResult: 442cc52072588b97d87b1bacc422d04d03b0180d:5db10c189567153906e7a351c9154e1256809a40872255708674a695c0643fb6 - request: method: GET uri: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28product_name%29&page=0&size=500 @@ -219,7 +219,7 @@ interactions: next: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3D%3D%27product_name%27&page=1&size=500 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/6fd1934de884a9b6f4c0a5b00c17a4fcb0e83aa7%3Ad10aa74a9819e440efdcf671e7b9d4c8bcdcb28c5009a3360c87c774c5d7a535?offset=0%2C0&limit=2%2C1000 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/442cc52072588b97d87b1bacc422d04d03b0180d%3A5db10c189567153906e7a351c9154e1256809a40872255708674a695c0643fb6?offset=0%2C0&limit=2%2C1000 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/dataframe/fixtures/filtered_empty_df.yaml b/packages/gooddata-pandas/tests/dataframe/fixtures/filtered_empty_df.yaml index 3f161136b..1b3a1678e 100644 --- a/packages/gooddata-pandas/tests/dataframe/fixtures/filtered_empty_df.yaml +++ b/packages/gooddata-pandas/tests/dataframe/fixtures/filtered_empty_df.yaml @@ -68,7 +68,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - b1767acf-64e6-4ad5-ae8a-d02e6b5f3391 + - 1321fd5c-b74d-458a-afdc-cc3c64cc771f X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -83,10 +83,10 @@ interactions: name: Revenue localIdentifier: dim_0 links: - executionResult: c59a0ac2eb27c3acd241654afbfdbb7d9f83a78b:90aacaa2a692188cf0f647074f57cbfa895ed096360076bfdc937193dfd6aa1a + executionResult: bccb57e3bcf6c970f661d4758fff7bfc97d086fd:80e02f6e9eb85a9285283881629ec0f535edadfaae86f872b53dec3742cbcc8a - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/c59a0ac2eb27c3acd241654afbfdbb7d9f83a78b%3A90aacaa2a692188cf0f647074f57cbfa895ed096360076bfdc937193dfd6aa1a?offset=0&limit=1 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/bccb57e3bcf6c970f661d4758fff7bfc97d086fd%3A80e02f6e9eb85a9285283881629ec0f535edadfaae86f872b53dec3742cbcc8a?offset=0&limit=1 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/dataframe/fixtures/multi_index_filtered_metrics_and_label.yaml b/packages/gooddata-pandas/tests/dataframe/fixtures/multi_index_filtered_metrics_and_label.yaml index 38082a3db..885bea059 100644 --- a/packages/gooddata-pandas/tests/dataframe/fixtures/multi_index_filtered_metrics_and_label.yaml +++ b/packages/gooddata-pandas/tests/dataframe/fixtures/multi_index_filtered_metrics_and_label.yaml @@ -102,7 +102,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 4ad5b0dc-508f-4c27-84fc-b4fa68100e4c + - e65228e1-68c6-4e75-a31f-53d9be1d2666 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -167,7 +167,7 @@ interactions: valueType: TEXT localIdentifier: dim_1 links: - executionResult: ad27c18a2a7b3289da2c6563f31855a2bc4508f2:8b7edec2b784f2d4447019d965a1b7f87d4e9bb77a3989fb7608fd695c0957f3 + executionResult: 33666e215e52a101836eb590e2469a5b70612092:4aa5eb4b3c83b8d4d2a55fbf506e404335ecef048b7d315545fd560c644e43f9 - request: method: GET uri: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28state%2Cregion%2Cproducts.category%29&page=0&size=500 @@ -290,10 +290,10 @@ interactions: type: dataset labels: data: - - id: geo__state__location - type: label - id: state type: label + - id: geo__state__location + type: label type: attribute included: - attributes: @@ -391,7 +391,7 @@ interactions: next: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28%27state%27%2C%27region%27%2C%27products.category%27%29&page=1&size=500 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/ad27c18a2a7b3289da2c6563f31855a2bc4508f2%3A8b7edec2b784f2d4447019d965a1b7f87d4e9bb77a3989fb7608fd695c0957f3?offset=0%2C0&limit=2%2C1000 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/33666e215e52a101836eb590e2469a5b70612092%3A4aa5eb4b3c83b8d4d2a55fbf506e404335ecef048b7d315545fd560c644e43f9?offset=0%2C0&limit=2%2C1000 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/dataframe/fixtures/multi_index_filtered_metrics_and_label_reuse.yaml b/packages/gooddata-pandas/tests/dataframe/fixtures/multi_index_filtered_metrics_and_label_reuse.yaml index b47322689..e6ecbcef9 100644 --- a/packages/gooddata-pandas/tests/dataframe/fixtures/multi_index_filtered_metrics_and_label_reuse.yaml +++ b/packages/gooddata-pandas/tests/dataframe/fixtures/multi_index_filtered_metrics_and_label_reuse.yaml @@ -91,7 +91,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 029a0735-bbb6-4db5-94fc-a2c8cd26544e + - a04172d7-579c-4da3-b293-3f9c020920d2 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -141,7 +141,7 @@ interactions: valueType: TEXT localIdentifier: dim_1 links: - executionResult: 6e6e7af719068d53f1aaa2e0feb883dbeb01b83a:923222e816c23d5cf275ab05e173ed0b3b26cf84c1178c8d26738b188b610616 + executionResult: 814bc53b8c6873b72f0b490cad2e3f40dd6ea57c:749563d455bc5c259960aef5f4014ce47571ae1cfb447695463c2300b0a90f72 - request: method: GET uri: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28region%2Cproducts.category%29&page=0&size=500 @@ -305,7 +305,7 @@ interactions: next: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28%27region%27%2C%27products.category%27%29&page=1&size=500 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/6e6e7af719068d53f1aaa2e0feb883dbeb01b83a%3A923222e816c23d5cf275ab05e173ed0b3b26cf84c1178c8d26738b188b610616?offset=0%2C0&limit=2%2C1000 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/814bc53b8c6873b72f0b490cad2e3f40dd6ea57c%3A749563d455bc5c259960aef5f4014ce47571ae1cfb447695463c2300b0a90f72?offset=0%2C0&limit=2%2C1000 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/dataframe/fixtures/multi_index_metrics.yaml b/packages/gooddata-pandas/tests/dataframe/fixtures/multi_index_metrics.yaml index ba722aa77..a47a03243 100644 --- a/packages/gooddata-pandas/tests/dataframe/fixtures/multi_index_metrics.yaml +++ b/packages/gooddata-pandas/tests/dataframe/fixtures/multi_index_metrics.yaml @@ -83,7 +83,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 3467289a-fa84-4a5c-b1ae-9e918a376553 + - 29036737-f4c2-4fc7-8031-cffa4346fa5b X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -133,7 +133,7 @@ interactions: valueType: TEXT localIdentifier: dim_1 links: - executionResult: ea732dcb7479a507eaa21cad47ac7c845b9c10ac:54e26df37663d25827f6c626e3334309fc35d1b30eaccb545dd2be1fed6348f4 + executionResult: 2b8726a09eebe0bcb964f41dc40814fbb29620ea:5f95ba376eaceaa63630e3d4c54abba64d11c4734ef3cbaeb7ff22e37f6b3437 - request: method: GET uri: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28region%2Cproducts.category%29&page=0&size=500 @@ -297,7 +297,7 @@ interactions: next: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28%27region%27%2C%27products.category%27%29&page=1&size=500 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/ea732dcb7479a507eaa21cad47ac7c845b9c10ac%3A54e26df37663d25827f6c626e3334309fc35d1b30eaccb545dd2be1fed6348f4?offset=0%2C0&limit=2%2C1000 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/2b8726a09eebe0bcb964f41dc40814fbb29620ea%3A5f95ba376eaceaa63630e3d4c54abba64d11c4734ef3cbaeb7ff22e37f6b3437?offset=0%2C0&limit=2%2C1000 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/dataframe/fixtures/multi_index_metrics_and_label.yaml b/packages/gooddata-pandas/tests/dataframe/fixtures/multi_index_metrics_and_label.yaml index ddddac14b..6d00762de 100644 --- a/packages/gooddata-pandas/tests/dataframe/fixtures/multi_index_metrics_and_label.yaml +++ b/packages/gooddata-pandas/tests/dataframe/fixtures/multi_index_metrics_and_label.yaml @@ -89,7 +89,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - ea1be92b-56e8-4b31-b475-b115f451d266 + - d07c561e-3d9c-404b-b3c6-ef35abcd7a1e X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -154,7 +154,7 @@ interactions: valueType: TEXT localIdentifier: dim_1 links: - executionResult: 80fbd26186fdab9c5f78d99a129d990489121f72:0ed179a2e0209e6aaa4735e8843d1aa452802394471de1981fbf94727ef54cf0 + executionResult: c98e08e58d7480595d2249d16889ee6ca1782953:0febbb81d7241a0ad65ac2feb2d5f934bbae6d0bbe54807129deeddff457c834 - request: method: GET uri: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28state%2Cregion%2Cproducts.category%29&page=0&size=500 @@ -277,10 +277,10 @@ interactions: type: dataset labels: data: - - id: geo__state__location - type: label - id: state type: label + - id: geo__state__location + type: label type: attribute included: - attributes: @@ -378,7 +378,7 @@ interactions: next: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28%27state%27%2C%27region%27%2C%27products.category%27%29&page=1&size=500 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/80fbd26186fdab9c5f78d99a129d990489121f72%3A0ed179a2e0209e6aaa4735e8843d1aa452802394471de1981fbf94727ef54cf0?offset=0%2C0&limit=2%2C1000 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/c98e08e58d7480595d2249d16889ee6ca1782953%3A0febbb81d7241a0ad65ac2feb2d5f934bbae6d0bbe54807129deeddff457c834?offset=0%2C0&limit=2%2C1000 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/dataframe/fixtures/not_indexed_filtered_metrics_and_labels.yaml b/packages/gooddata-pandas/tests/dataframe/fixtures/not_indexed_filtered_metrics_and_labels.yaml index 2b42ca854..d55c9dd64 100644 --- a/packages/gooddata-pandas/tests/dataframe/fixtures/not_indexed_filtered_metrics_and_labels.yaml +++ b/packages/gooddata-pandas/tests/dataframe/fixtures/not_indexed_filtered_metrics_and_labels.yaml @@ -85,7 +85,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 695caaff-a1ad-410a-b949-e42597b8927b + - 4e2571f9-59ec-4588-9513-bfa9ab5d4d5d X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -120,7 +120,7 @@ interactions: valueType: TEXT localIdentifier: dim_1 links: - executionResult: 399d105d0c06c7110cb3d199c74f6d9944711263:638ec474bf65063a90dd528fe84aa4a4404e4b2520996b1a20fa087b187b2d6b + executionResult: c5dc48f77c8af4bfa1f4f77c4cfb5257d0af3900:557bce91902d7aaaffd84663bd038952f16da4bfd352cfab145a4e0421503f48 - request: method: GET uri: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28region%29&page=0&size=500 @@ -227,7 +227,7 @@ interactions: next: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3D%3D%27region%27&page=1&size=500 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/399d105d0c06c7110cb3d199c74f6d9944711263%3A638ec474bf65063a90dd528fe84aa4a4404e4b2520996b1a20fa087b187b2d6b?offset=0%2C0&limit=2%2C1000 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/c5dc48f77c8af4bfa1f4f77c4cfb5257d0af3900%3A557bce91902d7aaaffd84663bd038952f16da4bfd352cfab145a4e0421503f48?offset=0%2C0&limit=2%2C1000 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/dataframe/fixtures/not_indexed_metrics.yaml b/packages/gooddata-pandas/tests/dataframe/fixtures/not_indexed_metrics.yaml index 07443aafb..510077146 100644 --- a/packages/gooddata-pandas/tests/dataframe/fixtures/not_indexed_metrics.yaml +++ b/packages/gooddata-pandas/tests/dataframe/fixtures/not_indexed_metrics.yaml @@ -69,7 +69,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 9b38b377-66a9-43ff-96dd-7a129ab543ce + - cf58c617-5505-4a6b-8f45-6bd043fbc973 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -87,10 +87,10 @@ interactions: name: '# of Orders' localIdentifier: dim_0 links: - executionResult: 7a2d3b34b6f9c0ab96f1fb6cb553ca0dff008419:523a472f602d79df2fbdc2b2ccf5f744f3e14e9f087835d586ec73171db5f126 + executionResult: b37b9b7260f3a003f5d822249b1188ed1d40e5eb:a9c087c4ebbec86a8b8d50759f128bc996c39c4058474af64de7b827115ce60f - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/7a2d3b34b6f9c0ab96f1fb6cb553ca0dff008419%3A523a472f602d79df2fbdc2b2ccf5f744f3e14e9f087835d586ec73171db5f126?offset=0&limit=2 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/b37b9b7260f3a003f5d822249b1188ed1d40e5eb%3Aa9c087c4ebbec86a8b8d50759f128bc996c39c4058474af64de7b827115ce60f?offset=0&limit=2 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/dataframe/fixtures/not_indexed_metrics_and_labels.yaml b/packages/gooddata-pandas/tests/dataframe/fixtures/not_indexed_metrics_and_labels.yaml index 674a99f39..06c9425b8 100644 --- a/packages/gooddata-pandas/tests/dataframe/fixtures/not_indexed_metrics_and_labels.yaml +++ b/packages/gooddata-pandas/tests/dataframe/fixtures/not_indexed_metrics_and_labels.yaml @@ -77,7 +77,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 6cb6a6bd-fbae-41c8-a4d9-d0008184d8ad + - 4ddd0ba7-3fa3-4165-8dbe-a00b5e6aa436 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -112,7 +112,7 @@ interactions: valueType: TEXT localIdentifier: dim_1 links: - executionResult: 471bdcea5732614ea40ab2126b8d6ccc28375548:272669889c50edddac6f6d7341976c6ee29f2c37c9175e5aeb605a33913001c8 + executionResult: 9c0a1e18c41104415b551e73d3df324ae46d9bf8:94b2ef8450f530f02dc471aa52d78600bc2d80446aa31d4deb927263e06a9e08 - request: method: GET uri: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28region%29&page=0&size=500 @@ -219,7 +219,7 @@ interactions: next: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3D%3D%27region%27&page=1&size=500 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/471bdcea5732614ea40ab2126b8d6ccc28375548%3A272669889c50edddac6f6d7341976c6ee29f2c37c9175e5aeb605a33913001c8?offset=0%2C0&limit=2%2C1000 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/9c0a1e18c41104415b551e73d3df324ae46d9bf8%3A94b2ef8450f530f02dc471aa52d78600bc2d80446aa31d4deb927263e06a9e08?offset=0%2C0&limit=2%2C1000 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/dataframe/fixtures/simple_index_filtered_metrics_and_label.yaml b/packages/gooddata-pandas/tests/dataframe/fixtures/simple_index_filtered_metrics_and_label.yaml index a86feeeed..b05557c38 100644 --- a/packages/gooddata-pandas/tests/dataframe/fixtures/simple_index_filtered_metrics_and_label.yaml +++ b/packages/gooddata-pandas/tests/dataframe/fixtures/simple_index_filtered_metrics_and_label.yaml @@ -122,7 +122,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - faf71399-f186-410b-9d0d-cec417e7320e + - f772ab7c-dbb7-4f3d-bc97-9e2def06b2c7 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -168,7 +168,7 @@ interactions: valueType: TEXT localIdentifier: dim_1 links: - executionResult: 6a1ce2e4ac787c66f430bbbf27307bd635d04f6a:811c0e1a56b8cfbf327693a1d7cb521be491f180bb7c92c68cb34620ccb1c10e + executionResult: 657f8d233dae5de14e5434c010e6730b0e2a53b1:a0026314fecdd7aa8887305a7822e6943b3e83b584cfa6966164501398687e29 - request: method: GET uri: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28products.category%2Cregion%29&page=0&size=500 @@ -332,7 +332,7 @@ interactions: next: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28%27products.category%27%2C%27region%27%29&page=1&size=500 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/6a1ce2e4ac787c66f430bbbf27307bd635d04f6a%3A811c0e1a56b8cfbf327693a1d7cb521be491f180bb7c92c68cb34620ccb1c10e?offset=0%2C0&limit=2%2C1000 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/657f8d233dae5de14e5434c010e6730b0e2a53b1%3Aa0026314fecdd7aa8887305a7822e6943b3e83b584cfa6966164501398687e29?offset=0%2C0&limit=2%2C1000 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/dataframe/fixtures/simple_index_metrics.yaml b/packages/gooddata-pandas/tests/dataframe/fixtures/simple_index_metrics.yaml index 31242d85e..b0c86e61b 100644 --- a/packages/gooddata-pandas/tests/dataframe/fixtures/simple_index_metrics.yaml +++ b/packages/gooddata-pandas/tests/dataframe/fixtures/simple_index_metrics.yaml @@ -75,7 +75,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 5c21d0ac-6e95-463c-b21b-8bb05a024512 + - 0ed9e56d-297d-42c9-9de5-eb28bf2a7150 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -120,7 +120,7 @@ interactions: valueType: TEXT localIdentifier: dim_1 links: - executionResult: 31bf7f18f9fb01ff21dd1f3ad0a6bf8dee00eca6:e33ddfa8ad4409e1f22cde7a62eb72c9f7cd9a087f201ba1f4d20c46d5bc1aeb + executionResult: 2d6091750fe015dc737d0333f400b834de8fceee:866127a68ad7efb02420528494c0d3c7cd9754efdec454a5851b39f6a05c49e4 - request: method: GET uri: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28region%2Cproducts.category%29&page=0&size=500 @@ -284,7 +284,7 @@ interactions: next: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28%27region%27%2C%27products.category%27%29&page=1&size=500 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/31bf7f18f9fb01ff21dd1f3ad0a6bf8dee00eca6%3Ae33ddfa8ad4409e1f22cde7a62eb72c9f7cd9a087f201ba1f4d20c46d5bc1aeb?offset=0%2C0&limit=1%2C1000 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/2d6091750fe015dc737d0333f400b834de8fceee%3A866127a68ad7efb02420528494c0d3c7cd9754efdec454a5851b39f6a05c49e4?offset=0%2C0&limit=1%2C1000 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/dataframe/fixtures/simple_index_metrics_and_label.yaml b/packages/gooddata-pandas/tests/dataframe/fixtures/simple_index_metrics_and_label.yaml index 5a4137f7d..6bebe77d5 100644 --- a/packages/gooddata-pandas/tests/dataframe/fixtures/simple_index_metrics_and_label.yaml +++ b/packages/gooddata-pandas/tests/dataframe/fixtures/simple_index_metrics_and_label.yaml @@ -79,7 +79,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 48f82896-b0ce-47f5-8de1-9ec408c8d7c7 + - 3ab30eaa-cbd5-48a7-b6c6-101464b00a6e X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -110,7 +110,7 @@ interactions: valueType: TEXT localIdentifier: dim_1 links: - executionResult: b7e06632be7a9c6efea190ae2d495231fd880abe:f46636d795e31fe5ee233ad9b575168ceac9a9fff684468d37c8bb3a86e16038 + executionResult: dc1d7e6cdaafeeb3575269d19e210492c5fad330:fe1776c418bd1c5c607eefcdff87a7364802fd27a9020ff6f24989989d79aa4f - request: method: GET uri: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28region%29&page=0&size=500 @@ -217,7 +217,7 @@ interactions: next: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3D%3D%27region%27&page=1&size=500 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/b7e06632be7a9c6efea190ae2d495231fd880abe%3Af46636d795e31fe5ee233ad9b575168ceac9a9fff684468d37c8bb3a86e16038?offset=0%2C0&limit=2%2C1000 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/dc1d7e6cdaafeeb3575269d19e210492c5fad330%3Afe1776c418bd1c5c607eefcdff87a7364802fd27a9020ff6f24989989d79aa4f?offset=0%2C0&limit=2%2C1000 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/dataframe/fixtures/simple_index_metrics_no_duplicate.yaml b/packages/gooddata-pandas/tests/dataframe/fixtures/simple_index_metrics_no_duplicate.yaml index ed633fd5d..3e7db62cb 100644 --- a/packages/gooddata-pandas/tests/dataframe/fixtures/simple_index_metrics_no_duplicate.yaml +++ b/packages/gooddata-pandas/tests/dataframe/fixtures/simple_index_metrics_no_duplicate.yaml @@ -79,7 +79,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - b7993546-19d5-4e87-bc18-b50d2eb4b68f + - 05a35463-e170-43f6-8747-0f42cf630bb3 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -110,7 +110,7 @@ interactions: valueType: TEXT localIdentifier: dim_1 links: - executionResult: b7e06632be7a9c6efea190ae2d495231fd880abe:f46636d795e31fe5ee233ad9b575168ceac9a9fff684468d37c8bb3a86e16038 + executionResult: dc1d7e6cdaafeeb3575269d19e210492c5fad330:fe1776c418bd1c5c607eefcdff87a7364802fd27a9020ff6f24989989d79aa4f - request: method: GET uri: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28region%29&page=0&size=500 @@ -217,7 +217,7 @@ interactions: next: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3D%3D%27region%27&page=1&size=500 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/b7e06632be7a9c6efea190ae2d495231fd880abe%3Af46636d795e31fe5ee233ad9b575168ceac9a9fff684468d37c8bb3a86e16038?offset=0%2C0&limit=2%2C1000 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/dc1d7e6cdaafeeb3575269d19e210492c5fad330%3Afe1776c418bd1c5c607eefcdff87a7364802fd27a9020ff6f24989989d79aa4f?offset=0%2C0&limit=2%2C1000 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/series/fixtures/multi_index_filtered_series.yaml b/packages/gooddata-pandas/tests/series/fixtures/multi_index_filtered_series.yaml index 29863eb80..f64dc1c68 100644 --- a/packages/gooddata-pandas/tests/series/fixtures/multi_index_filtered_series.yaml +++ b/packages/gooddata-pandas/tests/series/fixtures/multi_index_filtered_series.yaml @@ -83,7 +83,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 89ba3cf0-f23b-40dd-8a60-0cc3d09949b6 + - 11f2924f-95f7-4468-b8d7-97e04f4e16e9 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -128,7 +128,7 @@ interactions: valueType: TEXT localIdentifier: dim_1 links: - executionResult: 7ba033fee9714cbe8e6684b53517a9bb6617939c:35885c7f3f3852ed2de90234a4de1876846b67e543dc564dc396b4c6d8e9880e + executionResult: ce70d2b7705ee4ceb27bf5069b8a534f174b5b99:0327e9ad53b74b38a654b9ef0fb9a01ac8e88e2d7827555e8ee1ec693db2fe7c - request: method: GET uri: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28region%2Cproducts.category%29&page=0&size=500 @@ -292,7 +292,7 @@ interactions: next: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28%27region%27%2C%27products.category%27%29&page=1&size=500 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/7ba033fee9714cbe8e6684b53517a9bb6617939c%3A35885c7f3f3852ed2de90234a4de1876846b67e543dc564dc396b4c6d8e9880e?offset=0%2C0&limit=1%2C1000 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/ce70d2b7705ee4ceb27bf5069b8a534f174b5b99%3A0327e9ad53b74b38a654b9ef0fb9a01ac8e88e2d7827555e8ee1ec693db2fe7c?offset=0%2C0&limit=1%2C1000 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/series/fixtures/multi_index_metric_series.yaml b/packages/gooddata-pandas/tests/series/fixtures/multi_index_metric_series.yaml index a001f4b3f..11a17e17b 100644 --- a/packages/gooddata-pandas/tests/series/fixtures/multi_index_metric_series.yaml +++ b/packages/gooddata-pandas/tests/series/fixtures/multi_index_metric_series.yaml @@ -75,7 +75,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - a2aec0c7-c6a7-4aec-b0a6-198fc87f9d1b + - ad6a8a1d-24e8-45c7-bd16-0bc6633dbc88 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -120,7 +120,7 @@ interactions: valueType: TEXT localIdentifier: dim_1 links: - executionResult: 31bf7f18f9fb01ff21dd1f3ad0a6bf8dee00eca6:e33ddfa8ad4409e1f22cde7a62eb72c9f7cd9a087f201ba1f4d20c46d5bc1aeb + executionResult: 2d6091750fe015dc737d0333f400b834de8fceee:866127a68ad7efb02420528494c0d3c7cd9754efdec454a5851b39f6a05c49e4 - request: method: GET uri: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28region%2Cproducts.category%29&page=0&size=500 @@ -284,7 +284,7 @@ interactions: next: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28%27region%27%2C%27products.category%27%29&page=1&size=500 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/31bf7f18f9fb01ff21dd1f3ad0a6bf8dee00eca6%3Ae33ddfa8ad4409e1f22cde7a62eb72c9f7cd9a087f201ba1f4d20c46d5bc1aeb?offset=0%2C0&limit=1%2C1000 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/2d6091750fe015dc737d0333f400b834de8fceee%3A866127a68ad7efb02420528494c0d3c7cd9754efdec454a5851b39f6a05c49e4?offset=0%2C0&limit=1%2C1000 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/series/fixtures/not_indexed_filtered_metric_series.yaml b/packages/gooddata-pandas/tests/series/fixtures/not_indexed_filtered_metric_series.yaml index 6ddc6f617..70ae1a1ee 100644 --- a/packages/gooddata-pandas/tests/series/fixtures/not_indexed_filtered_metric_series.yaml +++ b/packages/gooddata-pandas/tests/series/fixtures/not_indexed_filtered_metric_series.yaml @@ -61,7 +61,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - dd3d85f4-ecb9-46ff-b41e-e1797fdd3187 + - 448a7676-3baa-4dcd-a770-04b8f332642c X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -74,10 +74,10 @@ interactions: - localIdentifier: 27c4b665b9d047b1a66a149714f1c596 localIdentifier: dim_0 links: - executionResult: e08d55eb1ddcd0e38beb91ccaa146efc07ac3474:016555fbfa3bd5a59d67c7bbe0ec546c98d2eda2d85c33c43c233961d4bda61e + executionResult: 9142b9edb3b0e5eda449c749b66ca4fd00ecafe8:6743f4e055423ff3b185238708f251ee15cb96cd7a98495dc31fda22def1055f - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/e08d55eb1ddcd0e38beb91ccaa146efc07ac3474%3A016555fbfa3bd5a59d67c7bbe0ec546c98d2eda2d85c33c43c233961d4bda61e?offset=0&limit=1 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/9142b9edb3b0e5eda449c749b66ca4fd00ecafe8%3A6743f4e055423ff3b185238708f251ee15cb96cd7a98495dc31fda22def1055f?offset=0&limit=1 body: null headers: Accept: @@ -201,7 +201,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 811d243c-295f-419e-adcd-b16d9369f490 + - a8a0c8e3-6069-46b2-a4f1-47ff21abe41a X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -214,10 +214,10 @@ interactions: - localIdentifier: 27c4b665b9d047b1a66a149714f1c596 localIdentifier: dim_0 links: - executionResult: 4950999468caeaf85abdeb0e5130b7b6c1c12d01:5deda89548507d6cc4cb3e546c281130f549401a36df7fa6594c9acca79bc36b + executionResult: 3e72d08512bdf19d14bd17c818d8043e098e7ca6:9d35a6353980952f9fb782afac484dcefe03c7d7640e4da4f164e065ea0a5cef - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/4950999468caeaf85abdeb0e5130b7b6c1c12d01%3A5deda89548507d6cc4cb3e546c281130f549401a36df7fa6594c9acca79bc36b?offset=0&limit=1 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/3e72d08512bdf19d14bd17c818d8043e098e7ca6%3A9d35a6353980952f9fb782afac484dcefe03c7d7640e4da4f164e065ea0a5cef?offset=0&limit=1 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/series/fixtures/not_indexed_label_series.yaml b/packages/gooddata-pandas/tests/series/fixtures/not_indexed_label_series.yaml index 3f44894e0..37658c2ca 100644 --- a/packages/gooddata-pandas/tests/series/fixtures/not_indexed_label_series.yaml +++ b/packages/gooddata-pandas/tests/series/fixtures/not_indexed_label_series.yaml @@ -56,7 +56,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 21e954df-685b-41dc-a6ee-21f3881445ba + - aab6555b-83b5-45d0-b5eb-147f870d659e X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -82,7 +82,7 @@ interactions: valueType: TEXT localIdentifier: dim_0 links: - executionResult: 83c05dc657245c60e343bb929193176beaa7a12c:ff771a6fd906e093ce5a7626e5d78d46f647bbb5ef59c0a3e8f43acb83ca940c + executionResult: 412044a44bdb7ace0524b4775a4d5847deea7be9:76c89cdca333ff451ff04d9d8b84998e7b81bd71bf7b84f39cbaf2d63d837d8e - request: method: GET uri: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28region%29&page=0&size=500 @@ -189,7 +189,7 @@ interactions: next: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3D%3D%27region%27&page=1&size=500 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/83c05dc657245c60e343bb929193176beaa7a12c%3Aff771a6fd906e093ce5a7626e5d78d46f647bbb5ef59c0a3e8f43acb83ca940c?offset=0&limit=1000 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/412044a44bdb7ace0524b4775a4d5847deea7be9%3A76c89cdca333ff451ff04d9d8b84998e7b81bd71bf7b84f39cbaf2d63d837d8e?offset=0&limit=1000 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/series/fixtures/not_indexed_label_series_with_granularity.yaml b/packages/gooddata-pandas/tests/series/fixtures/not_indexed_label_series_with_granularity.yaml index ab0ce29c6..4c43c5f73 100644 --- a/packages/gooddata-pandas/tests/series/fixtures/not_indexed_label_series_with_granularity.yaml +++ b/packages/gooddata-pandas/tests/series/fixtures/not_indexed_label_series_with_granularity.yaml @@ -62,7 +62,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 43b757fd-df70-4f62-85db-e694a22e9cab + - 8ade9cc6-2e1c-4e1b-93ad-acac9bc05e86 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -103,7 +103,7 @@ interactions: valueType: TEXT localIdentifier: dim_0 links: - executionResult: 6b0dc6d8bb38afd3b9a0ad582e3851f63064b394:4e1b826501f0981cf37e90069ab74540d21098fc05a4f9fe406c420dd81daca7 + executionResult: 3d049d00a020d3e96e8a68c613608b27cb27bb94:3b6fd2a86aea2b307aaa1f16e5478856ad465648d4a9292e2f83c4f85917f696 - request: method: GET uri: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28products.category%2Cregion%29&page=0&size=500 @@ -267,7 +267,7 @@ interactions: next: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28%27products.category%27%2C%27region%27%29&page=1&size=500 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/6b0dc6d8bb38afd3b9a0ad582e3851f63064b394%3A4e1b826501f0981cf37e90069ab74540d21098fc05a4f9fe406c420dd81daca7?offset=0&limit=1000 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/3d049d00a020d3e96e8a68c613608b27cb27bb94%3A3b6fd2a86aea2b307aaa1f16e5478856ad465648d4a9292e2f83c4f85917f696?offset=0&limit=1000 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/series/fixtures/not_indexed_metric_series.yaml b/packages/gooddata-pandas/tests/series/fixtures/not_indexed_metric_series.yaml index 063f202c1..db95fe817 100644 --- a/packages/gooddata-pandas/tests/series/fixtures/not_indexed_metric_series.yaml +++ b/packages/gooddata-pandas/tests/series/fixtures/not_indexed_metric_series.yaml @@ -61,7 +61,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - f4de3341-5fd2-42e7-8a6f-9f64b432c6d0 + - 99ae43fa-75a7-459e-9e38-2a6231e881f3 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -74,10 +74,10 @@ interactions: - localIdentifier: 27c4b665b9d047b1a66a149714f1c596 localIdentifier: dim_0 links: - executionResult: e08d55eb1ddcd0e38beb91ccaa146efc07ac3474:016555fbfa3bd5a59d67c7bbe0ec546c98d2eda2d85c33c43c233961d4bda61e + executionResult: 9142b9edb3b0e5eda449c749b66ca4fd00ecafe8:6743f4e055423ff3b185238708f251ee15cb96cd7a98495dc31fda22def1055f - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/e08d55eb1ddcd0e38beb91ccaa146efc07ac3474%3A016555fbfa3bd5a59d67c7bbe0ec546c98d2eda2d85c33c43c233961d4bda61e?offset=0&limit=1 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/9142b9edb3b0e5eda449c749b66ca4fd00ecafe8%3A6743f4e055423ff3b185238708f251ee15cb96cd7a98495dc31fda22def1055f?offset=0&limit=1 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/series/fixtures/not_indexed_metric_series_with_granularity.yaml b/packages/gooddata-pandas/tests/series/fixtures/not_indexed_metric_series_with_granularity.yaml index 6395c8462..459e8c50c 100644 --- a/packages/gooddata-pandas/tests/series/fixtures/not_indexed_metric_series_with_granularity.yaml +++ b/packages/gooddata-pandas/tests/series/fixtures/not_indexed_metric_series_with_granularity.yaml @@ -69,7 +69,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 5426fcf5-cf87-44b9-99b9-f7354a230cc9 + - 5aaaba5a-47a1-4489-a3cf-f77baa1d10d3 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -99,7 +99,7 @@ interactions: valueType: TEXT localIdentifier: dim_1 links: - executionResult: 7c08fe6732009241102a49be8ac6adf3b95185bb:d0e6a9518e96eee23fcf3a8dfbf2afd1ef94fdcc5ba943703b1287731559cdb3 + executionResult: 4a58538cbace9546e7eadcdc2d510a7b7bc37792:d98b5e52bae0d1221af152d3cb869ff5688d1bbd46966465d6af25a785873382 - request: method: GET uri: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28region%29&page=0&size=500 @@ -206,7 +206,7 @@ interactions: next: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3D%3D%27region%27&page=1&size=500 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/7c08fe6732009241102a49be8ac6adf3b95185bb%3Ad0e6a9518e96eee23fcf3a8dfbf2afd1ef94fdcc5ba943703b1287731559cdb3?offset=0%2C0&limit=1%2C1000 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/4a58538cbace9546e7eadcdc2d510a7b7bc37792%3Ad98b5e52bae0d1221af152d3cb869ff5688d1bbd46966465d6af25a785873382?offset=0%2C0&limit=1%2C1000 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/series/fixtures/simple_index_filtered_series.yaml b/packages/gooddata-pandas/tests/series/fixtures/simple_index_filtered_series.yaml index edb76bf99..ee37a8f63 100644 --- a/packages/gooddata-pandas/tests/series/fixtures/simple_index_filtered_series.yaml +++ b/packages/gooddata-pandas/tests/series/fixtures/simple_index_filtered_series.yaml @@ -78,7 +78,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - e1f2ee04-a71f-401f-9d35-47a47335d1a2 + - 3d8aa1f8-b6b5-4f21-b21c-25421e88b9e6 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -119,7 +119,7 @@ interactions: valueType: TEXT localIdentifier: dim_0 links: - executionResult: 40097ceaaee0bc36c4ae346cd30da6775770d7d4:ad119bca1376ab030cee23d9ce00a5233a9feef0c9b8f96ae9f334cbda5d8abc + executionResult: e40bb3a4da8f55b134f359268b5119a6a7b654e4:a16d4faaec7ce914238fdea64881b80b5db158c80dd9fdada113e15827cdb13a - request: method: GET uri: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28products.category%2Cregion%29&page=0&size=500 @@ -283,7 +283,7 @@ interactions: next: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28%27products.category%27%2C%27region%27%29&page=1&size=500 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/40097ceaaee0bc36c4ae346cd30da6775770d7d4%3Aad119bca1376ab030cee23d9ce00a5233a9feef0c9b8f96ae9f334cbda5d8abc?offset=0&limit=1000 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/e40bb3a4da8f55b134f359268b5119a6a7b654e4%3Aa16d4faaec7ce914238fdea64881b80b5db158c80dd9fdada113e15827cdb13a?offset=0&limit=1000 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/series/fixtures/simple_index_label_series.yaml b/packages/gooddata-pandas/tests/series/fixtures/simple_index_label_series.yaml index 679c930f9..2067d1b28 100644 --- a/packages/gooddata-pandas/tests/series/fixtures/simple_index_label_series.yaml +++ b/packages/gooddata-pandas/tests/series/fixtures/simple_index_label_series.yaml @@ -56,7 +56,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - ed2ff022-c1cb-4de2-aa3c-89704deeaf02 + - 8cc6b0c0-a047-4bd1-8ca8-cfd3261c4074 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -82,7 +82,7 @@ interactions: valueType: TEXT localIdentifier: dim_0 links: - executionResult: 83c05dc657245c60e343bb929193176beaa7a12c:ff771a6fd906e093ce5a7626e5d78d46f647bbb5ef59c0a3e8f43acb83ca940c + executionResult: 412044a44bdb7ace0524b4775a4d5847deea7be9:76c89cdca333ff451ff04d9d8b84998e7b81bd71bf7b84f39cbaf2d63d837d8e - request: method: GET uri: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28region%29&page=0&size=500 @@ -189,7 +189,7 @@ interactions: next: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3D%3D%27region%27&page=1&size=500 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/83c05dc657245c60e343bb929193176beaa7a12c%3Aff771a6fd906e093ce5a7626e5d78d46f647bbb5ef59c0a3e8f43acb83ca940c?offset=0&limit=1000 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/412044a44bdb7ace0524b4775a4d5847deea7be9%3A76c89cdca333ff451ff04d9d8b84998e7b81bd71bf7b84f39cbaf2d63d837d8e?offset=0&limit=1000 body: null headers: Accept: diff --git a/packages/gooddata-pandas/tests/series/fixtures/simple_index_metric_series.yaml b/packages/gooddata-pandas/tests/series/fixtures/simple_index_metric_series.yaml index 8b11e8b9e..0bbd50e0f 100644 --- a/packages/gooddata-pandas/tests/series/fixtures/simple_index_metric_series.yaml +++ b/packages/gooddata-pandas/tests/series/fixtures/simple_index_metric_series.yaml @@ -69,7 +69,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 08c55963-f876-422d-8bb0-e1d5e910083a + - a554eecd-ad19-4a20-874d-1fd8e8b3bddf X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -99,7 +99,7 @@ interactions: valueType: TEXT localIdentifier: dim_1 links: - executionResult: 7c08fe6732009241102a49be8ac6adf3b95185bb:d0e6a9518e96eee23fcf3a8dfbf2afd1ef94fdcc5ba943703b1287731559cdb3 + executionResult: 4a58538cbace9546e7eadcdc2d510a7b7bc37792:d98b5e52bae0d1221af152d3cb869ff5688d1bbd46966465d6af25a785873382 - request: method: GET uri: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3Din%3D%28region%29&page=0&size=500 @@ -206,7 +206,7 @@ interactions: next: http://localhost:3000/api/v1/entities/workspaces/demo/attributes?include=labels%2Cdatasets&filter=labels.id%3D%3D%27region%27&page=1&size=500 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/7c08fe6732009241102a49be8ac6adf3b95185bb%3Ad0e6a9518e96eee23fcf3a8dfbf2afd1ef94fdcc5ba943703b1287731559cdb3?offset=0%2C0&limit=1%2C1000 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/4a58538cbace9546e7eadcdc2d510a7b7bc37792%3Ad98b5e52bae0d1221af152d3cb869ff5688d1bbd46966465d6af25a785873382?offset=0%2C0&limit=1%2C1000 body: null headers: Accept: diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/bigquery.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/bigquery.yaml index fc3870779..aff54ff6b 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/bigquery.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/bigquery.yaml @@ -48,7 +48,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: c53063c8ef918680240504f9ce30f600 + traceId: 37e1a42827e86906169932f4efe3c3b5 - request: method: POST uri: http://localhost:3000/api/v1/entities/dataSources @@ -117,8 +117,8 @@ interactions: - name: projectId value: PROJECT_ID authenticationType: TOKEN - name: Test type: BIGQUERY + name: Test schema: demo id: test type: dataSource @@ -179,8 +179,8 @@ interactions: - name: projectId value: PROJECT_ID authenticationType: TOKEN - name: Test type: BIGQUERY + name: Test schema: demo id: test type: dataSource diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/demo_data_sources_list.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/demo_data_sources_list.yaml index 1f12b8494..820bd7c86 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/demo_data_sources_list.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/demo_data_sources_list.yaml @@ -22,7 +22,7 @@ interactions: Cache-Control: - no-cache, no-store, max-age=0, must-revalidate Content-Length: - - '491' + - '533' Content-Type: - application/json DATE: &id001 @@ -49,8 +49,9 @@ interactions: url: jdbc:postgresql://postgres:5432/tiger?sslmode=prefer username: postgres authenticationType: USERNAME_PASSWORD - name: demo-test-ds + alternativeDataSourceId: ds-put-abc-id type: POSTGRESQL + name: demo-test-ds schema: demo id: demo-test-ds links: diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/demo_put_declarative_data_sources_connection.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/demo_put_declarative_data_sources_connection.yaml index b95de3c95..ec61491f4 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/demo_put_declarative_data_sources_connection.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/demo_put_declarative_data_sources_connection.yaml @@ -113,7 +113,7 @@ interactions: string: queryDurationMillis: createCacheTable: 0 - simpleSelect: 10 + simpleSelect: 11 successful: true - request: method: PUT diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/demo_register_upload_notification.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/demo_register_upload_notification.yaml index 2a8d70bb1..95e8d3185 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/demo_register_upload_notification.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/demo_register_upload_notification.yaml @@ -481,7 +481,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 935a0a09-69eb-433d-9e7e-7adccd61a4e7 + - 5a04b2e6-e0d4-4127-a667-e8695e983ac7 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -496,7 +496,7 @@ interactions: name: '# of Active Customers' localIdentifier: dim_0 links: - executionResult: 34e108fe6c4a526559d0e33e81cbb5318025189d:3778ac3538b0e2f92b110745fef4b74c6dc56bc074e5f92ec130caec183aac1e + executionResult: 95b89c9086f1b18e0a6558aff9e43e89b6078d4c:3181aaf53eaac07fad7a07e20e25650125abd6f0201cd569d8322aa91bf42c40 - request: method: POST uri: http://localhost:3000/api/v1/actions/dataSources/demo-test-ds/uploadNotification @@ -593,7 +593,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - d91d4a29-08c0-4c5b-8f6c-0ce89feb6c9a + - 628242d4-dcea-46e0-a81d-11352ba976fe X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -608,4 +608,4 @@ interactions: name: '# of Active Customers' localIdentifier: dim_0 links: - executionResult: 8631dc1155f76f5dd07cd2d201763e331c0dfd0a:13dcf193a2b9595fd9c6dc937d3beb02cbe3c53373b63e4504db74e95fd9e9b4 + executionResult: ef6e504f57132890b39a97b697e39591383459ac:6b5a29f3862e29dcaab83fabf3b1867cfdaf80628ba38f2b90c8953b548a0f8a diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/dremio.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/dremio.yaml index b9d0f2427..cde209ccf 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/dremio.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/dremio.yaml @@ -48,7 +48,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: 700cf481d9cd8093d0a3fe5561feb668 + traceId: 02b10d84f94d78293c43adbe174a3e2e - request: method: POST uri: http://localhost:3000/api/v1/entities/dataSources @@ -108,8 +108,8 @@ interactions: url: jdbc:dremio:direct=dremio:31010 username: demouser authenticationType: USERNAME_PASSWORD - name: Dremio type: DREMIO + name: Dremio schema: '' id: dremio type: dataSource @@ -162,8 +162,8 @@ interactions: url: jdbc:dremio:direct=dremio:31010 username: demouser authenticationType: USERNAME_PASSWORD - name: Dremio type: DREMIO + name: Dremio schema: '' id: dremio type: dataSource diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/patch.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/patch.yaml index be51d9458..1ae8fc4df 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/patch.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/patch.yaml @@ -22,7 +22,7 @@ interactions: Cache-Control: - no-cache, no-store, max-age=0, must-revalidate Content-Length: - - '491' + - '533' Content-Type: - application/json DATE: &id001 @@ -49,8 +49,9 @@ interactions: url: jdbc:postgresql://postgres:5432/tiger?sslmode=prefer username: postgres authenticationType: USERNAME_PASSWORD - name: demo-test-ds + alternativeDataSourceId: ds-put-abc-id type: POSTGRESQL + name: demo-test-ds schema: demo id: demo-test-ds links: @@ -105,7 +106,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: 679348c39bfe13f2b419e66f9869de80 + traceId: b7cee86a9d4673f25271f9cb13150f19 - request: method: POST uri: http://localhost:3000/api/v1/entities/dataSources @@ -165,8 +166,8 @@ interactions: url: jdbc:postgresql://localhost:5432/demo?autosave=true&sslmode=prefer username: demouser authenticationType: USERNAME_PASSWORD - name: Test type: POSTGRESQL + name: Test schema: demo id: test type: dataSource @@ -219,8 +220,8 @@ interactions: url: jdbc:postgresql://localhost:5432/demo?autosave=true&sslmode=prefer username: demouser authenticationType: USERNAME_PASSWORD - name: Test type: POSTGRESQL + name: Test schema: demo id: test type: dataSource @@ -273,8 +274,8 @@ interactions: url: jdbc:postgresql://localhost:5432/demo?autosave=true&sslmode=prefer username: demouser authenticationType: USERNAME_PASSWORD - name: Test type: POSTGRESQL + name: Test schema: demo id: test type: dataSource @@ -338,8 +339,8 @@ interactions: username: demouser authenticationType: USERNAME_PASSWORD alternativeDataSourceId: ds-patch-abc-id - name: Test2 type: POSTGRESQL + name: Test2 schema: demo id: test type: dataSource @@ -393,8 +394,8 @@ interactions: username: demouser authenticationType: USERNAME_PASSWORD alternativeDataSourceId: ds-patch-abc-id - name: Test2 type: POSTGRESQL + name: Test2 schema: demo id: test type: dataSource diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/redshift.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/redshift.yaml index 0a098a5e5..95fb8d844 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/redshift.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/redshift.yaml @@ -48,7 +48,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: cdc92b598b2e30837fd22d3f5b372674 + traceId: fa4b5a557e3a095cabf598549cfbc5b5 - request: method: POST uri: http://localhost:3000/api/v1/entities/dataSources @@ -110,8 +110,8 @@ interactions: username: demouser authenticationType: USERNAME_PASSWORD alternativeDataSourceId: ds-abc-id - name: Test2 type: REDSHIFT + name: Test2 schema: demo id: test type: dataSource @@ -165,8 +165,8 @@ interactions: username: demouser authenticationType: USERNAME_PASSWORD alternativeDataSourceId: ds-abc-id - name: Test2 type: REDSHIFT + name: Test2 schema: demo id: test type: dataSource diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/snowflake.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/snowflake.yaml index c8de5da27..41f7734d3 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/snowflake.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/snowflake.yaml @@ -48,7 +48,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: 6643a66fbff87004fba99ae97cf9f84f + traceId: ce826389b737093baaec4426736c902d - request: method: POST uri: http://localhost:3000/api/v1/entities/dataSources @@ -108,8 +108,8 @@ interactions: url: jdbc:snowflake://gooddata.snowflakecomputing.com:443/?application=GoodData_GoodDataCN&db=TIGER&useProxy=true&warehouse=TIGER username: demouser authenticationType: USERNAME_PASSWORD - name: Test type: SNOWFLAKE + name: Test schema: demo id: test type: dataSource @@ -162,8 +162,8 @@ interactions: url: jdbc:snowflake://gooddata.snowflakecomputing.com:443/?application=GoodData_GoodDataCN&db=TIGER&useProxy=true&warehouse=TIGER username: demouser authenticationType: USERNAME_PASSWORD - name: Test type: SNOWFLAKE + name: Test schema: demo id: test type: dataSource @@ -253,7 +253,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: bacf22845f9bce84caaf7903b2e762d1 + traceId: 580885c78d8bb144681054f36d7f37b1 - request: method: POST uri: http://localhost:3000/api/v1/entities/dataSources @@ -314,8 +314,8 @@ interactions: url: jdbc:snowflake://gooddata.snowflakecomputing.com:443/?application=GoodData_GoodDataCN&db=TIGER&useProxy=true&warehouse=TIGER username: demouser authenticationType: KEY_PAIR - name: Test type: SNOWFLAKE + name: Test schema: demo id: test type: dataSource @@ -368,8 +368,8 @@ interactions: url: jdbc:snowflake://gooddata.snowflakecomputing.com:443/?application=GoodData_GoodDataCN&db=TIGER&useProxy=true&warehouse=TIGER username: demouser authenticationType: KEY_PAIR - name: Test type: SNOWFLAKE + name: Test schema: demo id: test type: dataSource diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/test_create_update.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/test_create_update.yaml index 435ca290c..842f79ad3 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/test_create_update.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/test_create_update.yaml @@ -22,7 +22,7 @@ interactions: Cache-Control: - no-cache, no-store, max-age=0, must-revalidate Content-Length: - - '491' + - '533' Content-Type: - application/json DATE: &id001 @@ -49,8 +49,9 @@ interactions: url: jdbc:postgresql://postgres:5432/tiger?sslmode=prefer username: postgres authenticationType: USERNAME_PASSWORD - name: demo-test-ds + alternativeDataSourceId: ds-put-abc-id type: POSTGRESQL + name: demo-test-ds schema: demo id: demo-test-ds links: @@ -105,7 +106,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: 77efccf11b01c7c07784bb752d01c36f + traceId: 2666a1b0e508fd186b549daf89f6508b - request: method: POST uri: http://localhost:3000/api/v1/entities/dataSources @@ -165,8 +166,8 @@ interactions: url: jdbc:postgresql://localhost:5432/demo?autosave=true&sslmode=prefer username: demouser authenticationType: USERNAME_PASSWORD - name: Test type: POSTGRESQL + name: Test schema: demo id: test type: dataSource @@ -219,8 +220,8 @@ interactions: url: jdbc:postgresql://localhost:5432/demo?autosave=true&sslmode=prefer username: demouser authenticationType: USERNAME_PASSWORD - name: Test type: POSTGRESQL + name: Test schema: demo id: test type: dataSource @@ -273,8 +274,8 @@ interactions: url: jdbc:postgresql://localhost:5432/demo?autosave=true&sslmode=prefer username: demouser authenticationType: USERNAME_PASSWORD - name: Test type: POSTGRESQL + name: Test schema: demo id: test type: dataSource @@ -339,8 +340,8 @@ interactions: url: jdbc:postgresql://localhost:5432/demo?autosave=false&sslmode=prefer username: demouser authenticationType: USERNAME_PASSWORD - name: Test2 type: POSTGRESQL + name: Test2 schema: demo id: test type: dataSource @@ -367,7 +368,7 @@ interactions: Cache-Control: - no-cache, no-store, max-age=0, must-revalidate Content-Length: - - '804' + - '846' Content-Type: - application/json DATE: *id001 @@ -393,8 +394,9 @@ interactions: url: jdbc:postgresql://postgres:5432/tiger?sslmode=prefer username: postgres authenticationType: USERNAME_PASSWORD - name: demo-test-ds + alternativeDataSourceId: ds-put-abc-id type: POSTGRESQL + name: demo-test-ds schema: demo id: demo-test-ds links: @@ -404,8 +406,8 @@ interactions: url: jdbc:postgresql://localhost:5432/demo?autosave=false&sslmode=prefer username: demouser authenticationType: USERNAME_PASSWORD - name: Test2 type: POSTGRESQL + name: Test2 schema: demo id: test links: @@ -452,60 +454,3 @@ interactions: - '0' body: string: '' - - request: - method: GET - uri: http://localhost:3000/api/v1/entities/dataSources?page=0&size=500 - body: null - headers: - Accept: - - application/json - Accept-Encoding: - - br, gzip, deflate - X-GDC-VALIDATE-RELATIONS: - - 'true' - X-Requested-With: - - XMLHttpRequest - response: - status: - code: 200 - message: OK - headers: - Cache-Control: - - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '491' - Content-Type: - - application/json - DATE: *id001 - Expires: - - '0' - Pragma: - - no-cache - Referrer-Policy: - - no-referrer - Vary: - - Origin - - Access-Control-Request-Method - - Access-Control-Request-Headers - X-Content-Type-Options: - - nosniff - X-GDC-TRACE-ID: *id001 - X-Xss-Protection: - - '0' - body: - string: - data: - - attributes: - url: jdbc:postgresql://postgres:5432/tiger?sslmode=prefer - username: postgres - authenticationType: USERNAME_PASSWORD - name: demo-test-ds - type: POSTGRESQL - schema: demo - id: demo-test-ds - links: - self: http://localhost:3000/api/v1/entities/dataSources/demo-test-ds - type: dataSource - links: - self: http://localhost:3000/api/v1/entities/dataSources?page=0&size=500 - next: http://localhost:3000/api/v1/entities/dataSources?page=1&size=500 diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/vertica.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/vertica.yaml index 8377d1041..33d9b5569 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/vertica.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/data_sources/vertica.yaml @@ -48,7 +48,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: 364c73debf21dbdd106d30e5f4320080 + traceId: d8097d684923d48d073db0c02d44a6b7 - request: method: POST uri: http://localhost:3000/api/v1/entities/dataSources @@ -108,8 +108,8 @@ interactions: url: jdbc:vertica://localhost:5433/demo?TLSmode=false username: demouser authenticationType: USERNAME_PASSWORD - name: Test2 type: VERTICA + name: Test2 schema: demo id: test type: dataSource @@ -162,8 +162,8 @@ interactions: url: jdbc:vertica://localhost:5433/demo?TLSmode=false username: demouser authenticationType: USERNAME_PASSWORD - name: Test2 type: VERTICA + name: Test2 schema: demo id: test type: dataSource diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/organization/create_csp_directive.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/organization/create_csp_directive.yaml index 946166393..508df60a1 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/organization/create_csp_directive.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/organization/create_csp_directive.yaml @@ -148,49 +148,3 @@ interactions: - '0' body: string: '' - - request: - method: GET - uri: http://localhost:3000/api/v1/entities/cspDirectives?page=0&size=500 - body: null - headers: - Accept: - - application/json - Accept-Encoding: - - br, gzip, deflate - X-GDC-VALIDATE-RELATIONS: - - 'true' - X-Requested-With: - - XMLHttpRequest - response: - status: - code: 200 - message: OK - headers: - Cache-Control: - - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '175' - Content-Type: - - application/json - DATE: *id001 - Expires: - - '0' - Pragma: - - no-cache - Referrer-Policy: - - no-referrer - Vary: - - Origin - - Access-Control-Request-Method - - Access-Control-Request-Headers - X-Content-Type-Options: - - nosniff - X-GDC-TRACE-ID: *id001 - X-Xss-Protection: - - '0' - body: - string: - data: [] - links: - self: http://localhost:3000/api/v1/entities/cspDirectives?page=0&size=500 - next: http://localhost:3000/api/v1/entities/cspDirectives?page=1&size=500 diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/organization/create_jwk.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/organization/create_jwk.yaml index 8ae6a5d80..ccd2dd9ea 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/organization/create_jwk.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/organization/create_jwk.yaml @@ -48,7 +48,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: 23f2fbeaf723091021db36d96ad4a498 + traceId: 9b4763659bc0ddb970f9abc02527ab27 - request: method: POST uri: http://localhost:3000/api/v1/entities/jwks @@ -219,49 +219,3 @@ interactions: - '0' body: string: '' - - request: - method: GET - uri: http://localhost:3000/api/v1/entities/jwks?page=0&size=500 - body: null - headers: - Accept: - - application/json - Accept-Encoding: - - br, gzip, deflate - X-GDC-VALIDATE-RELATIONS: - - 'true' - X-Requested-With: - - XMLHttpRequest - response: - status: - code: 200 - message: OK - headers: - Cache-Control: - - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '157' - Content-Type: - - application/json - DATE: *id001 - Expires: - - '0' - Pragma: - - no-cache - Referrer-Policy: - - no-referrer - Vary: - - Origin - - Access-Control-Request-Method - - Access-Control-Request-Headers - X-Content-Type-Options: - - nosniff - X-GDC-TRACE-ID: *id001 - X-Xss-Protection: - - '0' - body: - string: - data: [] - links: - self: http://localhost:3000/api/v1/entities/jwks?page=0&size=500 - next: http://localhost:3000/api/v1/entities/jwks?page=1&size=500 diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/organization/create_organization_setting.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/organization/create_organization_setting.yaml index 367d918a3..43ffb91e6 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/organization/create_organization_setting.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/organization/create_organization_setting.yaml @@ -151,49 +151,3 @@ interactions: - '0' body: string: '' - - request: - method: GET - uri: http://localhost:3000/api/v1/entities/organizationSettings?page=0&size=500 - body: null - headers: - Accept: - - application/json - Accept-Encoding: - - br, gzip, deflate - X-GDC-VALIDATE-RELATIONS: - - 'true' - X-Requested-With: - - XMLHttpRequest - response: - status: - code: 200 - message: OK - headers: - Cache-Control: - - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '189' - Content-Type: - - application/json - DATE: *id001 - Expires: - - '0' - Pragma: - - no-cache - Referrer-Policy: - - no-referrer - Vary: - - Origin - - Access-Control-Request-Method - - Access-Control-Request-Headers - X-Content-Type-Options: - - nosniff - X-GDC-TRACE-ID: *id001 - X-Xss-Protection: - - '0' - body: - string: - data: [] - links: - self: http://localhost:3000/api/v1/entities/organizationSettings?page=0&size=500 - next: http://localhost:3000/api/v1/entities/organizationSettings?page=1&size=500 diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/organization/delete_csp_directive.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/organization/delete_csp_directive.yaml index 1b4c01ef5..e522e9cd1 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/organization/delete_csp_directive.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/organization/delete_csp_directive.yaml @@ -144,60 +144,12 @@ interactions: to access it. status: 404 title: Not Found - traceId: f89f827944659bcfde284f5e15cb0b1f + traceId: 5ddacf1a74d0f2d9be40dc093fbe1c90 - request: - method: GET - uri: http://localhost:3000/api/v1/entities/cspDirectives?page=0&size=500 - body: null - headers: - Accept: - - application/json - Accept-Encoding: - - br, gzip, deflate - X-GDC-VALIDATE-RELATIONS: - - 'true' - X-Requested-With: - - XMLHttpRequest - response: - status: - code: 200 - message: OK - headers: - Cache-Control: - - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '175' - Content-Type: - - application/json - DATE: *id001 - Expires: - - '0' - Pragma: - - no-cache - Referrer-Policy: - - no-referrer - Vary: - - Origin - - Access-Control-Request-Method - - Access-Control-Request-Headers - X-Content-Type-Options: - - nosniff - X-GDC-TRACE-ID: *id001 - X-Xss-Protection: - - '0' - body: - string: - data: [] - links: - self: http://localhost:3000/api/v1/entities/cspDirectives?page=0&size=500 - next: http://localhost:3000/api/v1/entities/cspDirectives?page=1&size=500 - - request: - method: GET - uri: http://localhost:3000/api/v1/entities/cspDirectives?page=0&size=500 + method: DELETE + uri: http://localhost:3000/api/v1/entities/cspDirectives/font-src body: null headers: - Accept: - - application/json Accept-Encoding: - br, gzip, deflate X-GDC-VALIDATE-RELATIONS: @@ -206,15 +158,13 @@ interactions: - XMLHttpRequest response: status: - code: 200 - message: OK + code: 204 + message: No Content headers: Cache-Control: - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '175' Content-Type: - - application/json + - application/vnd.gooddata.api+json DATE: *id001 Expires: - '0' @@ -232,8 +182,4 @@ interactions: X-Xss-Protection: - '0' body: - string: - data: [] - links: - self: http://localhost:3000/api/v1/entities/cspDirectives?page=0&size=500 - next: http://localhost:3000/api/v1/entities/cspDirectives?page=1&size=500 + string: '' diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/organization/delete_jwk.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/organization/delete_jwk.yaml index 17e65cbc8..0c2288716 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/organization/delete_jwk.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/organization/delete_jwk.yaml @@ -48,7 +48,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: a4f3b05c80347758fc93609e04e59150 + traceId: 50403b8c321fe1063fc2c8fc58131811 - request: method: POST uri: http://localhost:3000/api/v1/entities/jwks @@ -207,60 +207,12 @@ interactions: to access it. status: 404 title: Not Found - traceId: ef24f4b136f3d25fdeedf805a9600edc + traceId: 0feeae7e7e1b02482d535f35c261e190 - request: - method: GET - uri: http://localhost:3000/api/v1/entities/jwks?page=0&size=500 - body: null - headers: - Accept: - - application/json - Accept-Encoding: - - br, gzip, deflate - X-GDC-VALIDATE-RELATIONS: - - 'true' - X-Requested-With: - - XMLHttpRequest - response: - status: - code: 200 - message: OK - headers: - Cache-Control: - - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '157' - Content-Type: - - application/json - DATE: *id001 - Expires: - - '0' - Pragma: - - no-cache - Referrer-Policy: - - no-referrer - Vary: - - Origin - - Access-Control-Request-Method - - Access-Control-Request-Headers - X-Content-Type-Options: - - nosniff - X-GDC-TRACE-ID: *id001 - X-Xss-Protection: - - '0' - body: - string: - data: [] - links: - self: http://localhost:3000/api/v1/entities/jwks?page=0&size=500 - next: http://localhost:3000/api/v1/entities/jwks?page=1&size=500 - - request: - method: GET - uri: http://localhost:3000/api/v1/entities/jwks?page=0&size=500 + method: DELETE + uri: http://localhost:3000/api/v1/entities/jwks/demoJwk body: null headers: - Accept: - - application/json Accept-Encoding: - br, gzip, deflate X-GDC-VALIDATE-RELATIONS: @@ -269,15 +221,13 @@ interactions: - XMLHttpRequest response: status: - code: 200 - message: OK + code: 204 + message: No Content headers: Cache-Control: - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '157' Content-Type: - - application/json + - application/vnd.gooddata.api+json DATE: *id001 Expires: - '0' @@ -295,8 +245,4 @@ interactions: X-Xss-Protection: - '0' body: - string: - data: [] - links: - self: http://localhost:3000/api/v1/entities/jwks?page=0&size=500 - next: http://localhost:3000/api/v1/entities/jwks?page=1&size=500 + string: '' diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/organization/delete_llm_endpoint.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/organization/delete_llm_endpoint.yaml index 82faa301e..ae3ba0b7d 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/organization/delete_llm_endpoint.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/organization/delete_llm_endpoint.yaml @@ -145,7 +145,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: a835c601a222fc31c6b5d136881a4eba + traceId: 274eae8ce489fe9e008ac571f6566bdc - request: method: DELETE uri: http://localhost:3000/api/v1/entities/llmEndpoints/endpoint1 diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/organization/delete_organization_setting.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/organization/delete_organization_setting.yaml index dd07fa2f2..ee5585942 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/organization/delete_organization_setting.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/organization/delete_organization_setting.yaml @@ -146,60 +146,12 @@ interactions: to access it. status: 404 title: Not Found - traceId: 146642f7681b6421598e6253cb99c391 + traceId: 6cda07ef0d4e7e33ec29b64fb8987ac5 - request: - method: GET - uri: http://localhost:3000/api/v1/entities/organizationSettings?page=0&size=500 - body: null - headers: - Accept: - - application/json - Accept-Encoding: - - br, gzip, deflate - X-GDC-VALIDATE-RELATIONS: - - 'true' - X-Requested-With: - - XMLHttpRequest - response: - status: - code: 200 - message: OK - headers: - Cache-Control: - - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '189' - Content-Type: - - application/json - DATE: *id001 - Expires: - - '0' - Pragma: - - no-cache - Referrer-Policy: - - no-referrer - Vary: - - Origin - - Access-Control-Request-Method - - Access-Control-Request-Headers - X-Content-Type-Options: - - nosniff - X-GDC-TRACE-ID: *id001 - X-Xss-Protection: - - '0' - body: - string: - data: [] - links: - self: http://localhost:3000/api/v1/entities/organizationSettings?page=0&size=500 - next: http://localhost:3000/api/v1/entities/organizationSettings?page=1&size=500 - - request: - method: GET - uri: http://localhost:3000/api/v1/entities/organizationSettings?page=0&size=500 + method: DELETE + uri: http://localhost:3000/api/v1/entities/organizationSettings/test_setting body: null headers: - Accept: - - application/json Accept-Encoding: - br, gzip, deflate X-GDC-VALIDATE-RELATIONS: @@ -208,15 +160,13 @@ interactions: - XMLHttpRequest response: status: - code: 200 - message: OK + code: 204 + message: No Content headers: Cache-Control: - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '189' Content-Type: - - application/json + - application/vnd.gooddata.api+json DATE: *id001 Expires: - '0' @@ -234,8 +184,4 @@ interactions: X-Xss-Protection: - '0' body: - string: - data: [] - links: - self: http://localhost:3000/api/v1/entities/organizationSettings?page=0&size=500 - next: http://localhost:3000/api/v1/entities/organizationSettings?page=1&size=500 + string: '' diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/organization/layout_notification_channels.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/organization/layout_notification_channels.yaml index 816c3470b..abb34f795 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/organization/layout_notification_channels.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/organization/layout_notification_channels.yaml @@ -1,50 +1,6 @@ # (C) 2026 GoodData Corporation version: 1 interactions: - - request: - method: GET - uri: http://localhost:3000/api/v1/layout/notificationChannels - body: null - headers: - Accept: - - application/json - Accept-Encoding: - - br, gzip, deflate - X-GDC-VALIDATE-RELATIONS: - - 'true' - X-Requested-With: - - XMLHttpRequest - response: - status: - code: 200 - message: OK - headers: - Cache-Control: - - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '27' - Content-Type: - - application/json - DATE: &id001 - - PLACEHOLDER - Expires: - - '0' - Pragma: - - no-cache - Referrer-Policy: - - no-referrer - Vary: - - Origin - - Access-Control-Request-Method - - Access-Control-Request-Headers - X-Content-Type-Options: - - nosniff - X-GDC-TRACE-ID: *id001 - X-Xss-Protection: - - '0' - body: - string: - notificationChannels: [] - request: method: PUT uri: http://localhost:3000/api/v1/layout/notificationChannels @@ -74,7 +30,8 @@ interactions: headers: Cache-Control: - no-cache, no-store, max-age=0, must-revalidate - DATE: *id001 + DATE: &id001 + - PLACEHOLDER Expires: - '0' Pragma: @@ -147,85 +104,3 @@ interactions: id: webhook inPlatformNotification: DISABLED name: Webhook - - request: - method: PUT - uri: http://localhost:3000/api/v1/layout/notificationChannels - body: - notificationChannels: [] - headers: - Accept-Encoding: - - br, gzip, deflate - Content-Type: - - application/json - X-GDC-VALIDATE-RELATIONS: - - 'true' - X-Requested-With: - - XMLHttpRequest - response: - status: - code: 204 - message: No Content - headers: - Cache-Control: - - no-cache, no-store, max-age=0, must-revalidate - DATE: *id001 - Expires: - - '0' - Pragma: - - no-cache - Referrer-Policy: - - no-referrer - Vary: - - Origin - - Access-Control-Request-Method - - Access-Control-Request-Headers - X-Content-Type-Options: - - nosniff - X-GDC-TRACE-ID: *id001 - X-Xss-Protection: - - '0' - body: - string: '' - - request: - method: GET - uri: http://localhost:3000/api/v1/layout/notificationChannels - body: null - headers: - Accept: - - application/json - Accept-Encoding: - - br, gzip, deflate - X-GDC-VALIDATE-RELATIONS: - - 'true' - X-Requested-With: - - XMLHttpRequest - response: - status: - code: 200 - message: OK - headers: - Cache-Control: - - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '27' - Content-Type: - - application/json - DATE: *id001 - Expires: - - '0' - Pragma: - - no-cache - Referrer-Policy: - - no-referrer - Vary: - - Origin - - Access-Control-Request-Method - - Access-Control-Request-Headers - X-Content-Type-Options: - - nosniff - X-GDC-TRACE-ID: *id001 - X-Xss-Protection: - - '0' - body: - string: - notificationChannels: [] diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/organization/list_csp_directives.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/organization/list_csp_directives.yaml index 29f8e6451..e218054e0 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/organization/list_csp_directives.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/organization/list_csp_directives.yaml @@ -1,6 +1,53 @@ # (C) 2026 GoodData Corporation version: 1 interactions: + - request: + method: GET + uri: http://localhost:3000/api/v1/entities/cspDirectives?page=0&size=500 + body: null + headers: + Accept: + - application/json + Accept-Encoding: + - br, gzip, deflate + X-GDC-VALIDATE-RELATIONS: + - 'true' + X-Requested-With: + - XMLHttpRequest + response: + status: + code: 200 + message: OK + headers: + Cache-Control: + - no-cache, no-store, max-age=0, must-revalidate + Content-Length: + - '175' + Content-Type: + - application/json + DATE: &id001 + - PLACEHOLDER + Expires: + - '0' + Pragma: + - no-cache + Referrer-Policy: + - no-referrer + Vary: + - Origin + - Access-Control-Request-Method + - Access-Control-Request-Headers + X-Content-Type-Options: + - nosniff + X-GDC-TRACE-ID: *id001 + X-Xss-Protection: + - '0' + body: + string: + data: [] + links: + self: http://localhost:3000/api/v1/entities/cspDirectives?page=0&size=500 + next: http://localhost:3000/api/v1/entities/cspDirectives?page=1&size=500 - request: method: POST uri: http://localhost:3000/api/v1/entities/cspDirectives @@ -33,8 +80,7 @@ interactions: - '174' Content-Type: - application/json - DATE: &id001 - - PLACEHOLDER + DATE: *id001 Expires: - '0' Pragma: @@ -254,49 +300,3 @@ interactions: - '0' body: string: '' - - request: - method: GET - uri: http://localhost:3000/api/v1/entities/cspDirectives?page=0&size=500 - body: null - headers: - Accept: - - application/json - Accept-Encoding: - - br, gzip, deflate - X-GDC-VALIDATE-RELATIONS: - - 'true' - X-Requested-With: - - XMLHttpRequest - response: - status: - code: 200 - message: OK - headers: - Cache-Control: - - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '175' - Content-Type: - - application/json - DATE: *id001 - Expires: - - '0' - Pragma: - - no-cache - Referrer-Policy: - - no-referrer - Vary: - - Origin - - Access-Control-Request-Method - - Access-Control-Request-Headers - X-Content-Type-Options: - - nosniff - X-GDC-TRACE-ID: *id001 - X-Xss-Protection: - - '0' - body: - string: - data: [] - links: - self: http://localhost:3000/api/v1/entities/cspDirectives?page=0&size=500 - next: http://localhost:3000/api/v1/entities/cspDirectives?page=1&size=500 diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/organization/list_jwk.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/organization/list_jwk.yaml index c70698595..6d28fca65 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/organization/list_jwk.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/organization/list_jwk.yaml @@ -1,6 +1,53 @@ # (C) 2026 GoodData Corporation version: 1 interactions: + - request: + method: GET + uri: http://localhost:3000/api/v1/entities/jwks?page=0&size=500 + body: null + headers: + Accept: + - application/json + Accept-Encoding: + - br, gzip, deflate + X-GDC-VALIDATE-RELATIONS: + - 'true' + X-Requested-With: + - XMLHttpRequest + response: + status: + code: 200 + message: OK + headers: + Cache-Control: + - no-cache, no-store, max-age=0, must-revalidate + Content-Length: + - '157' + Content-Type: + - application/json + DATE: &id001 + - PLACEHOLDER + Expires: + - '0' + Pragma: + - no-cache + Referrer-Policy: + - no-referrer + Vary: + - Origin + - Access-Control-Request-Method + - Access-Control-Request-Headers + X-Content-Type-Options: + - nosniff + X-GDC-TRACE-ID: *id001 + X-Xss-Protection: + - '0' + body: + string: + data: [] + links: + self: http://localhost:3000/api/v1/entities/jwks?page=0&size=500 + next: http://localhost:3000/api/v1/entities/jwks?page=1&size=500 - request: method: GET uri: http://localhost:3000/api/v1/entities/jwks/demoJwk1 @@ -25,8 +72,7 @@ interactions: - '172' Content-Type: - application/problem+json - DATE: &id001 - - PLACEHOLDER + DATE: *id001 Expires: - '0' Pragma: @@ -48,7 +94,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: b17fd012e5b3b8f7b8bc0c9b13ba360e + traceId: bc8aebd5faa8c115ffddfca055d58514 - request: method: POST uri: http://localhost:3000/api/v1/entities/jwks @@ -169,7 +215,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: 9fce0d3e9276b26d8aec1d1f530c52b1 + traceId: 87eb46f0d82935510e0e5bee1acafba8 - request: method: POST uri: http://localhost:3000/api/v1/entities/jwks @@ -396,49 +442,3 @@ interactions: - '0' body: string: '' - - request: - method: GET - uri: http://localhost:3000/api/v1/entities/jwks?page=0&size=500 - body: null - headers: - Accept: - - application/json - Accept-Encoding: - - br, gzip, deflate - X-GDC-VALIDATE-RELATIONS: - - 'true' - X-Requested-With: - - XMLHttpRequest - response: - status: - code: 200 - message: OK - headers: - Cache-Control: - - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '157' - Content-Type: - - application/json - DATE: *id001 - Expires: - - '0' - Pragma: - - no-cache - Referrer-Policy: - - no-referrer - Vary: - - Origin - - Access-Control-Request-Method - - Access-Control-Request-Headers - X-Content-Type-Options: - - nosniff - X-GDC-TRACE-ID: *id001 - X-Xss-Protection: - - '0' - body: - string: - data: [] - links: - self: http://localhost:3000/api/v1/entities/jwks?page=0&size=500 - next: http://localhost:3000/api/v1/entities/jwks?page=1&size=500 diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/organization/list_llm_endpoints.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/organization/list_llm_endpoints.yaml index 7a491246e..f41aaf317 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/organization/list_llm_endpoints.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/organization/list_llm_endpoints.yaml @@ -1,6 +1,53 @@ # (C) 2026 GoodData Corporation version: 1 interactions: + - request: + method: GET + uri: http://localhost:3000/api/v1/entities/llmEndpoints + body: null + headers: + Accept: + - application/json + Accept-Encoding: + - br, gzip, deflate + X-GDC-VALIDATE-RELATIONS: + - 'true' + X-Requested-With: + - XMLHttpRequest + response: + status: + code: 200 + message: OK + headers: + Cache-Control: + - no-cache, no-store, max-age=0, must-revalidate + Content-Length: + - '171' + Content-Type: + - application/json + DATE: &id001 + - PLACEHOLDER + Expires: + - '0' + Pragma: + - no-cache + Referrer-Policy: + - no-referrer + Vary: + - Origin + - Access-Control-Request-Method + - Access-Control-Request-Headers + X-Content-Type-Options: + - nosniff + X-GDC-TRACE-ID: *id001 + X-Xss-Protection: + - '0' + body: + string: + data: [] + links: + self: http://localhost:3000/api/v1/entities/llmEndpoints?page=0&size=20 + next: http://localhost:3000/api/v1/entities/llmEndpoints?page=1&size=20 - request: method: POST uri: http://localhost:3000/api/v1/entities/llmEndpoints @@ -33,8 +80,7 @@ interactions: - '209' Content-Type: - application/json - DATE: &id001 - - PLACEHOLDER + DATE: *id001 Expires: - '0' Pragma: diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/organization/list_organization_settings.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/organization/list_organization_settings.yaml index 69ae23680..41de7b288 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/organization/list_organization_settings.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/organization/list_organization_settings.yaml @@ -1,6 +1,53 @@ # (C) 2026 GoodData Corporation version: 1 interactions: + - request: + method: GET + uri: http://localhost:3000/api/v1/entities/organizationSettings?page=0&size=500 + body: null + headers: + Accept: + - application/json + Accept-Encoding: + - br, gzip, deflate + X-GDC-VALIDATE-RELATIONS: + - 'true' + X-Requested-With: + - XMLHttpRequest + response: + status: + code: 200 + message: OK + headers: + Cache-Control: + - no-cache, no-store, max-age=0, must-revalidate + Content-Length: + - '189' + Content-Type: + - application/json + DATE: &id001 + - PLACEHOLDER + Expires: + - '0' + Pragma: + - no-cache + Referrer-Policy: + - no-referrer + Vary: + - Origin + - Access-Control-Request-Method + - Access-Control-Request-Headers + X-Content-Type-Options: + - nosniff + X-GDC-TRACE-ID: *id001 + X-Xss-Protection: + - '0' + body: + string: + data: [] + links: + self: http://localhost:3000/api/v1/entities/organizationSettings?page=0&size=500 + next: http://localhost:3000/api/v1/entities/organizationSettings?page=1&size=500 - request: method: POST uri: http://localhost:3000/api/v1/entities/organizationSettings @@ -34,8 +81,7 @@ interactions: - '213' Content-Type: - application/json - DATE: &id001 - - PLACEHOLDER + DATE: *id001 Expires: - '0' Pragma: @@ -260,49 +306,3 @@ interactions: - '0' body: string: '' - - request: - method: GET - uri: http://localhost:3000/api/v1/entities/organizationSettings?page=0&size=500 - body: null - headers: - Accept: - - application/json - Accept-Encoding: - - br, gzip, deflate - X-GDC-VALIDATE-RELATIONS: - - 'true' - X-Requested-With: - - XMLHttpRequest - response: - status: - code: 200 - message: OK - headers: - Cache-Control: - - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '189' - Content-Type: - - application/json - DATE: *id001 - Expires: - - '0' - Pragma: - - no-cache - Referrer-Policy: - - no-referrer - Vary: - - Origin - - Access-Control-Request-Method - - Access-Control-Request-Headers - X-Content-Type-Options: - - nosniff - X-GDC-TRACE-ID: *id001 - X-Xss-Protection: - - '0' - body: - string: - data: [] - links: - self: http://localhost:3000/api/v1/entities/organizationSettings?page=0&size=500 - next: http://localhost:3000/api/v1/entities/organizationSettings?page=1&size=500 diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/organization/update_allowed_origins.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/organization/update_allowed_origins.yaml index b9fd9a7c4..a50ae9795 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/organization/update_allowed_origins.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/organization/update_allowed_origins.yaml @@ -103,40 +103,32 @@ interactions: links: self: http://localhost:3000/api/v1/entities/admin/organizations/default - request: - method: PATCH - uri: http://localhost:3000/api/v1/entities/admin/organizations/default - body: - data: - id: default - type: organization - attributes: - allowedOrigins: - - https://test.com + method: GET + uri: http://localhost:3000/api/v1/entities/organization + body: null headers: - Accept: - - application/json Accept-Encoding: - br, gzip, deflate - Content-Type: - - application/json X-GDC-VALIDATE-RELATIONS: - 'true' X-Requested-With: - XMLHttpRequest response: status: - code: 200 - message: OK + code: 302 + message: Found headers: Cache-Control: - no-cache, no-store, max-age=0, must-revalidate Content-Length: - - '468' + - '0' Content-Type: - - application/json + - application/vnd.gooddata.api+json DATE: *id001 Expires: - '0' + Location: + - /api/v1/entities/admin/organizations/default Pragma: - no-cache Referrer-Policy: @@ -151,30 +143,10 @@ interactions: X-Xss-Protection: - '0' body: - string: - data: - attributes: - name: Default Organization - hostname: localhost - allowedOrigins: - - https://test.com - earlyAccess: enableAlerting - earlyAccessValues: - - enableAlerting - - enableSmtp - - enablePreAggregationDatasets - - enableScheduling - - enableCompositeGrain - - enableUserManagement - - enableRawExports - - enableFlexibleDashboardLayout - id: default - type: organization - links: - self: http://localhost:3000/api/v1/entities/admin/organizations/default + string: '' - request: method: GET - uri: http://localhost:3000/api/v1/entities/organization + uri: http://localhost:3000/api/v1/entities/admin/organizations/default body: null headers: Accept-Encoding: @@ -185,20 +157,18 @@ interactions: - XMLHttpRequest response: status: - code: 302 - message: Found + code: 200 + message: OK headers: Cache-Control: - no-cache, no-store, max-age=0, must-revalidate Content-Length: - - '0' + - '430' Content-Type: - application/vnd.gooddata.api+json DATE: *id001 Expires: - '0' - Location: - - /api/v1/entities/admin/organizations/default Pragma: - no-cache Referrer-Policy: @@ -213,14 +183,42 @@ interactions: X-Xss-Protection: - '0' body: - string: '' + string: + data: + attributes: + name: Default Organization + hostname: localhost + earlyAccess: enableAlerting + earlyAccessValues: + - enableAlerting + - enableSmtp + - enablePreAggregationDatasets + - enableScheduling + - enableCompositeGrain + - enableUserManagement + - enableRawExports + - enableFlexibleDashboardLayout + id: default + type: organization + links: + self: http://localhost:3000/api/v1/entities/admin/organizations/default - request: - method: GET + method: PATCH uri: http://localhost:3000/api/v1/entities/admin/organizations/default - body: null + body: + data: + id: default + type: organization + attributes: + allowedOrigins: + - https://test.com headers: + Accept: + - application/json Accept-Encoding: - br, gzip, deflate + Content-Type: + - application/json X-GDC-VALIDATE-RELATIONS: - 'true' X-Requested-With: @@ -235,7 +233,7 @@ interactions: Content-Length: - '468' Content-Type: - - application/vnd.gooddata.api+json + - application/json DATE: *id001 Expires: - '0' @@ -377,39 +375,32 @@ interactions: links: self: http://localhost:3000/api/v1/entities/admin/organizations/default - request: - method: PATCH - uri: http://localhost:3000/api/v1/entities/admin/organizations/default - body: - data: - id: default - type: organization - attributes: - allowedOrigins: [] + method: GET + uri: http://localhost:3000/api/v1/entities/organization + body: null headers: - Accept: - - application/json Accept-Encoding: - br, gzip, deflate - Content-Type: - - application/json X-GDC-VALIDATE-RELATIONS: - 'true' X-Requested-With: - XMLHttpRequest response: status: - code: 200 - message: OK + code: 302 + message: Found headers: Cache-Control: - no-cache, no-store, max-age=0, must-revalidate Content-Length: - - '450' + - '0' Content-Type: - - application/json + - application/vnd.gooddata.api+json DATE: *id001 Expires: - '0' + Location: + - /api/v1/entities/admin/organizations/default Pragma: - no-cache Referrer-Policy: @@ -424,29 +415,10 @@ interactions: X-Xss-Protection: - '0' body: - string: - data: - attributes: - name: Default Organization - hostname: localhost - allowedOrigins: [] - earlyAccess: enableAlerting - earlyAccessValues: - - enableAlerting - - enableSmtp - - enablePreAggregationDatasets - - enableScheduling - - enableCompositeGrain - - enableUserManagement - - enableRawExports - - enableFlexibleDashboardLayout - id: default - type: organization - links: - self: http://localhost:3000/api/v1/entities/admin/organizations/default + string: '' - request: method: GET - uri: http://localhost:3000/api/v1/entities/organization + uri: http://localhost:3000/api/v1/entities/admin/organizations/default body: null headers: Accept-Encoding: @@ -457,20 +429,18 @@ interactions: - XMLHttpRequest response: status: - code: 302 - message: Found + code: 200 + message: OK headers: Cache-Control: - no-cache, no-store, max-age=0, must-revalidate Content-Length: - - '0' + - '468' Content-Type: - application/vnd.gooddata.api+json DATE: *id001 Expires: - '0' - Location: - - /api/v1/entities/admin/organizations/default Pragma: - no-cache Referrer-Policy: @@ -485,14 +455,43 @@ interactions: X-Xss-Protection: - '0' body: - string: '' + string: + data: + attributes: + name: Default Organization + hostname: localhost + allowedOrigins: + - https://test.com + earlyAccess: enableAlerting + earlyAccessValues: + - enableAlerting + - enableSmtp + - enablePreAggregationDatasets + - enableScheduling + - enableCompositeGrain + - enableUserManagement + - enableRawExports + - enableFlexibleDashboardLayout + id: default + type: organization + links: + self: http://localhost:3000/api/v1/entities/admin/organizations/default - request: - method: GET + method: PATCH uri: http://localhost:3000/api/v1/entities/admin/organizations/default - body: null + body: + data: + id: default + type: organization + attributes: + allowedOrigins: [] headers: + Accept: + - application/json Accept-Encoding: - br, gzip, deflate + Content-Type: + - application/json X-GDC-VALIDATE-RELATIONS: - 'true' X-Requested-With: @@ -507,7 +506,7 @@ interactions: Content-Length: - '450' Content-Type: - - application/vnd.gooddata.api+json + - application/json DATE: *id001 Expires: - '0' diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/organization/update_csp_directive.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/organization/update_csp_directive.yaml index 2349014a9..8f40c92e5 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/organization/update_csp_directive.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/organization/update_csp_directive.yaml @@ -206,49 +206,3 @@ interactions: - '0' body: string: '' - - request: - method: GET - uri: http://localhost:3000/api/v1/entities/cspDirectives?page=0&size=500 - body: null - headers: - Accept: - - application/json - Accept-Encoding: - - br, gzip, deflate - X-GDC-VALIDATE-RELATIONS: - - 'true' - X-Requested-With: - - XMLHttpRequest - response: - status: - code: 200 - message: OK - headers: - Cache-Control: - - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '175' - Content-Type: - - application/json - DATE: *id001 - Expires: - - '0' - Pragma: - - no-cache - Referrer-Policy: - - no-referrer - Vary: - - Origin - - Access-Control-Request-Method - - Access-Control-Request-Headers - X-Content-Type-Options: - - nosniff - X-GDC-TRACE-ID: *id001 - X-Xss-Protection: - - '0' - body: - string: - data: [] - links: - self: http://localhost:3000/api/v1/entities/cspDirectives?page=0&size=500 - next: http://localhost:3000/api/v1/entities/cspDirectives?page=1&size=500 diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/organization/update_jwk.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/organization/update_jwk.yaml index 03977c941..2a54c485b 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/organization/update_jwk.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/organization/update_jwk.yaml @@ -48,7 +48,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: e0e9de4902870139cf633d548b44387c + traceId: df33a86ccca079b948a5d8494358af6c - request: method: POST uri: http://localhost:3000/api/v1/entities/jwks @@ -351,49 +351,3 @@ interactions: - '0' body: string: '' - - request: - method: GET - uri: http://localhost:3000/api/v1/entities/jwks?page=0&size=500 - body: null - headers: - Accept: - - application/json - Accept-Encoding: - - br, gzip, deflate - X-GDC-VALIDATE-RELATIONS: - - 'true' - X-Requested-With: - - XMLHttpRequest - response: - status: - code: 200 - message: OK - headers: - Cache-Control: - - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '157' - Content-Type: - - application/json - DATE: *id001 - Expires: - - '0' - Pragma: - - no-cache - Referrer-Policy: - - no-referrer - Vary: - - Origin - - Access-Control-Request-Method - - Access-Control-Request-Headers - X-Content-Type-Options: - - nosniff - X-GDC-TRACE-ID: *id001 - X-Xss-Protection: - - '0' - body: - string: - data: [] - links: - self: http://localhost:3000/api/v1/entities/jwks?page=0&size=500 - next: http://localhost:3000/api/v1/entities/jwks?page=1&size=500 diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/organization/update_name.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/organization/update_name.yaml index 3e993735e..a6aec949f 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/organization/update_name.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/organization/update_name.yaml @@ -536,103 +536,3 @@ interactions: type: organization links: self: http://localhost:3000/api/v1/entities/admin/organizations/default - - request: - method: GET - uri: http://localhost:3000/api/v1/entities/organization - body: null - headers: - Accept-Encoding: - - br, gzip, deflate - X-GDC-VALIDATE-RELATIONS: - - 'true' - X-Requested-With: - - XMLHttpRequest - response: - status: - code: 302 - message: Found - headers: - Cache-Control: - - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '0' - Content-Type: - - application/vnd.gooddata.api+json - DATE: *id001 - Expires: - - '0' - Location: - - /api/v1/entities/admin/organizations/default - Pragma: - - no-cache - Referrer-Policy: - - no-referrer - Vary: - - Origin - - Access-Control-Request-Method - - Access-Control-Request-Headers - X-Content-Type-Options: - - nosniff - X-GDC-TRACE-ID: *id001 - X-Xss-Protection: - - '0' - body: - string: '' - - request: - method: GET - uri: http://localhost:3000/api/v1/entities/admin/organizations/default - body: null - headers: - Accept-Encoding: - - br, gzip, deflate - X-GDC-VALIDATE-RELATIONS: - - 'true' - X-Requested-With: - - XMLHttpRequest - response: - status: - code: 200 - message: OK - headers: - Cache-Control: - - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '430' - Content-Type: - - application/vnd.gooddata.api+json - DATE: *id001 - Expires: - - '0' - Pragma: - - no-cache - Referrer-Policy: - - no-referrer - Vary: - - Origin - - Access-Control-Request-Method - - Access-Control-Request-Headers - X-Content-Type-Options: - - nosniff - X-GDC-TRACE-ID: *id001 - X-Xss-Protection: - - '0' - body: - string: - data: - attributes: - name: Default Organization - hostname: localhost - earlyAccess: enableAlerting - earlyAccessValues: - - enableAlerting - - enableSmtp - - enablePreAggregationDatasets - - enableScheduling - - enableCompositeGrain - - enableUserManagement - - enableRawExports - - enableFlexibleDashboardLayout - id: default - type: organization - links: - self: http://localhost:3000/api/v1/entities/admin/organizations/default diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/organization/update_organization_setting.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/organization/update_organization_setting.yaml index 82f7d0781..ace5979e0 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/organization/update_organization_setting.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/organization/update_organization_setting.yaml @@ -211,49 +211,3 @@ interactions: - '0' body: string: '' - - request: - method: GET - uri: http://localhost:3000/api/v1/entities/organizationSettings?page=0&size=500 - body: null - headers: - Accept: - - application/json - Accept-Encoding: - - br, gzip, deflate - X-GDC-VALIDATE-RELATIONS: - - 'true' - X-Requested-With: - - XMLHttpRequest - response: - status: - code: 200 - message: OK - headers: - Cache-Control: - - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '189' - Content-Type: - - application/json - DATE: *id001 - Expires: - - '0' - Pragma: - - no-cache - Referrer-Policy: - - no-referrer - Vary: - - Origin - - Access-Control-Request-Method - - Access-Control-Request-Headers - X-Content-Type-Options: - - nosniff - X-GDC-TRACE-ID: *id001 - X-Xss-Protection: - - '0' - body: - string: - data: [] - links: - self: http://localhost:3000/api/v1/entities/organizationSettings?page=0&size=500 - next: http://localhost:3000/api/v1/entities/organizationSettings?page=1&size=500 diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/permissions/list_dashboard_permissions.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/permissions/list_dashboard_permissions.yaml index d9d7d8b39..a19aaee60 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/permissions/list_dashboard_permissions.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/permissions/list_dashboard_permissions.yaml @@ -148,48 +148,3 @@ interactions: - '0' body: string: '' - - request: - method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/analyticalDashboards/campaign/permissions - body: null - headers: - Accept: - - application/json - Accept-Encoding: - - br, gzip, deflate - X-GDC-VALIDATE-RELATIONS: - - 'true' - X-Requested-With: - - XMLHttpRequest - response: - status: - code: 200 - message: OK - headers: - Cache-Control: - - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '39' - Content-Type: - - application/json - DATE: *id001 - Expires: - - '0' - Pragma: - - no-cache - Referrer-Policy: - - no-referrer - Vary: - - Origin - - Access-Control-Request-Method - - Access-Control-Request-Headers - X-Content-Type-Options: - - nosniff - X-GDC-TRACE-ID: *id001 - X-Xss-Protection: - - '0' - body: - string: - rules: [] - userGroups: [] - users: [] diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/permissions/manage_dashboard_permissions_declarative_workspace.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/permissions/manage_dashboard_permissions_declarative_workspace.yaml index 9c32fb233..d26adc6ab 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/permissions/manage_dashboard_permissions_declarative_workspace.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/permissions/manage_dashboard_permissions_declarative_workspace.yaml @@ -2076,48 +2076,3 @@ interactions: - '0' body: string: '' - - request: - method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/analyticalDashboards/campaign/permissions - body: null - headers: - Accept: - - application/json - Accept-Encoding: - - br, gzip, deflate - X-GDC-VALIDATE-RELATIONS: - - 'true' - X-Requested-With: - - XMLHttpRequest - response: - status: - code: 200 - message: OK - headers: - Cache-Control: - - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '39' - Content-Type: - - application/json - DATE: *id001 - Expires: - - '0' - Pragma: - - no-cache - Referrer-Policy: - - no-referrer - Vary: - - Origin - - Access-Control-Request-Method - - Access-Control-Request-Headers - X-Content-Type-Options: - - nosniff - X-GDC-TRACE-ID: *id001 - X-Xss-Protection: - - '0' - body: - string: - rules: [] - userGroups: [] - users: [] diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/permissions/manage_organization_permissions.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/permissions/manage_organization_permissions.yaml index 5ed4b41be..f46403828 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/permissions/manage_organization_permissions.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/permissions/manage_organization_permissions.yaml @@ -138,49 +138,3 @@ interactions: - '0' body: string: '' - - request: - method: GET - uri: http://localhost:3000/api/v1/layout/organization/permissions - body: null - headers: - Accept: - - application/json - Accept-Encoding: - - br, gzip, deflate - X-GDC-VALIDATE-RELATIONS: - - 'true' - X-Requested-With: - - XMLHttpRequest - response: - status: - code: 200 - message: OK - headers: - Cache-Control: - - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '69' - Content-Type: - - application/json - DATE: *id001 - Expires: - - '0' - Pragma: - - no-cache - Referrer-Policy: - - no-referrer - Vary: - - Origin - - Access-Control-Request-Method - - Access-Control-Request-Headers - X-Content-Type-Options: - - nosniff - X-GDC-TRACE-ID: *id001 - X-Xss-Protection: - - '0' - body: - string: - - assignee: - id: adminGroup - type: userGroup - name: MANAGE diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/permissions/put_declarative_organization_permissions.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/permissions/put_declarative_organization_permissions.yaml index 4b61efd6b..2b08bb92a 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/permissions/put_declarative_organization_permissions.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/permissions/put_declarative_organization_permissions.yaml @@ -140,49 +140,3 @@ interactions: - '0' body: string: '' - - request: - method: GET - uri: http://localhost:3000/api/v1/layout/organization/permissions - body: null - headers: - Accept: - - application/json - Accept-Encoding: - - br, gzip, deflate - X-GDC-VALIDATE-RELATIONS: - - 'true' - X-Requested-With: - - XMLHttpRequest - response: - status: - code: 200 - message: OK - headers: - Cache-Control: - - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '69' - Content-Type: - - application/json - DATE: *id001 - Expires: - - '0' - Pragma: - - no-cache - Referrer-Policy: - - no-referrer - Vary: - - Origin - - Access-Control-Request-Method - - Access-Control-Request-Headers - X-Content-Type-Options: - - nosniff - X-GDC-TRACE-ID: *id001 - X-Xss-Protection: - - '0' - body: - string: - - assignee: - id: adminGroup - type: userGroup - name: MANAGE diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/permissions/put_declarative_permissions.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/permissions/put_declarative_permissions.yaml index 86cd2ebe9..5b8d6d58d 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/permissions/put_declarative_permissions.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/permissions/put_declarative_permissions.yaml @@ -202,47 +202,3 @@ interactions: - '0' body: string: '' - - request: - method: GET - uri: http://localhost:3000/api/v1/layout/workspaces/demo_west/permissions - body: null - headers: - Accept: - - application/json - Accept-Encoding: - - br, gzip, deflate - X-GDC-VALIDATE-RELATIONS: - - 'true' - X-Requested-With: - - XMLHttpRequest - response: - status: - code: 200 - message: OK - headers: - Cache-Control: - - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '44' - Content-Type: - - application/json - DATE: *id001 - Expires: - - '0' - Pragma: - - no-cache - Referrer-Policy: - - no-referrer - Vary: - - Origin - - Access-Control-Request-Method - - Access-Control-Request-Headers - X-Content-Type-Options: - - nosniff - X-GDC-TRACE-ID: *id001 - X-Xss-Protection: - - '0' - body: - string: - hierarchyPermissions: [] - permissions: [] diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/users/create_delete_user.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/users/create_delete_user.yaml index af0fcf7f9..fb2e01e7d 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/users/create_delete_user.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/users/create_delete_user.yaml @@ -56,7 +56,7 @@ interactions: type: userGroup type: user - attributes: - authenticationId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + authenticationId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs firstname: Demo lastname: User email: demo@example.com @@ -70,7 +70,7 @@ interactions: type: userGroup type: user - attributes: - authenticationId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + authenticationId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs id: demo2 links: self: http://localhost:3000/api/v1/entities/users/demo2 @@ -141,7 +141,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: 551cfb57b825be68c5117688582aa69d + traceId: e68381bf8adcd3cb3c1e298ba9be3ed1 - request: method: POST uri: http://localhost:3000/api/v1/entities/users @@ -327,7 +327,7 @@ interactions: type: userGroup type: user - attributes: - authenticationId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + authenticationId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs firstname: Demo lastname: User email: demo@example.com @@ -341,7 +341,7 @@ interactions: type: userGroup type: user - attributes: - authenticationId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + authenticationId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs id: demo2 links: self: http://localhost:3000/api/v1/entities/users/demo2 @@ -418,96 +418,3 @@ interactions: - '0' body: string: '' - - request: - method: GET - uri: http://localhost:3000/api/v1/entities/users?include=userGroups&page=0&size=500 - body: null - headers: - Accept: - - application/json - Accept-Encoding: - - br, gzip, deflate - X-GDC-VALIDATE-RELATIONS: - - 'true' - X-Requested-With: - - XMLHttpRequest - response: - status: - code: 200 - message: OK - headers: - Cache-Control: - - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '1302' - Content-Type: - - application/json - DATE: *id001 - Expires: - - '0' - Pragma: - - no-cache - Referrer-Policy: - - no-referrer - Vary: - - Origin - - Access-Control-Request-Method - - Access-Control-Request-Headers - X-Content-Type-Options: - - nosniff - X-GDC-TRACE-ID: *id001 - X-Xss-Protection: - - '0' - body: - string: - data: - - attributes: {} - id: admin - links: - self: http://localhost:3000/api/v1/entities/users/admin - relationships: - userGroups: - data: - - id: adminGroup - type: userGroup - type: user - - attributes: - authenticationId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs - firstname: Demo - lastname: User - email: demo@example.com - id: demo - links: - self: http://localhost:3000/api/v1/entities/users/demo - relationships: - userGroups: - data: - - id: adminGroup - type: userGroup - type: user - - attributes: - authenticationId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs - id: demo2 - links: - self: http://localhost:3000/api/v1/entities/users/demo2 - relationships: - userGroups: - data: - - id: demoGroup - type: userGroup - type: user - included: - - attributes: {} - id: adminGroup - links: - self: http://localhost:3000/api/v1/entities/userGroups/adminGroup - type: userGroup - - attributes: - name: demo group - id: demoGroup - links: - self: http://localhost:3000/api/v1/entities/userGroups/demoGroup - type: userGroup - links: - self: http://localhost:3000/api/v1/entities/users?include=userGroups&page=0&size=500 - next: http://localhost:3000/api/v1/entities/users?include=userGroups&page=1&size=500 diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/users/create_delete_user_group.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/users/create_delete_user_group.yaml index 3a134bd23..a340a7a23 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/users/create_delete_user_group.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/users/create_delete_user_group.yaml @@ -138,7 +138,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: 05b3748794a60418839f225e4f97c5fb + traceId: 9c3e5f56198b317cfd0b6c0fff7cccec - request: method: POST uri: http://localhost:3000/api/v1/entities/userGroups @@ -400,93 +400,3 @@ interactions: - '0' body: string: '' - - request: - method: GET - uri: http://localhost:3000/api/v1/entities/userGroups?include=userGroups&page=0&size=500 - body: null - headers: - Accept: - - application/json - Accept-Encoding: - - br, gzip, deflate - X-GDC-VALIDATE-RELATIONS: - - 'true' - X-Requested-With: - - XMLHttpRequest - response: - status: - code: 200 - message: OK - headers: - Cache-Control: - - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '1241' - Content-Type: - - application/json - DATE: *id001 - Expires: - - '0' - Pragma: - - no-cache - Referrer-Policy: - - no-referrer - Vary: - - Origin - - Access-Control-Request-Method - - Access-Control-Request-Headers - X-Content-Type-Options: - - nosniff - X-GDC-TRACE-ID: *id001 - X-Xss-Protection: - - '0' - body: - string: - data: - - attributes: {} - id: adminGroup - links: - self: http://localhost:3000/api/v1/entities/userGroups/adminGroup - type: userGroup - - attributes: {} - id: adminQA1Group - links: - self: http://localhost:3000/api/v1/entities/userGroups/adminQA1Group - relationships: - parents: - data: - - id: adminGroup - type: userGroup - type: userGroup - - attributes: - name: demo group - id: demoGroup - links: - self: http://localhost:3000/api/v1/entities/userGroups/demoGroup - type: userGroup - - attributes: - name: visitors - id: visitorsGroup - links: - self: http://localhost:3000/api/v1/entities/userGroups/visitorsGroup - relationships: - parents: - data: - - id: demoGroup - type: userGroup - type: userGroup - included: - - attributes: {} - id: adminGroup - links: - self: http://localhost:3000/api/v1/entities/userGroups/adminGroup - type: userGroup - - attributes: - name: demo group - id: demoGroup - links: - self: http://localhost:3000/api/v1/entities/userGroups/demoGroup - type: userGroup - links: - self: http://localhost:3000/api/v1/entities/userGroups?include=userGroups&page=0&size=500 - next: http://localhost:3000/api/v1/entities/userGroups?include=userGroups&page=1&size=500 diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/users/get_declarative_users.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/users/get_declarative_users.yaml index 986bc6427..8a2405729 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/users/get_declarative_users.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/users/get_declarative_users.yaml @@ -51,7 +51,7 @@ interactions: userGroups: - id: adminGroup type: userGroup - - authId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + - authId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs email: demo@example.com firstname: Demo id: demo @@ -61,7 +61,7 @@ interactions: userGroups: - id: adminGroup type: userGroup - - authId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + - authId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs id: demo2 permissions: [] settings: [] @@ -117,7 +117,7 @@ interactions: userGroups: - id: adminGroup type: userGroup - - authId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + - authId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs email: demo@example.com firstname: Demo id: demo @@ -127,7 +127,7 @@ interactions: userGroups: - id: adminGroup type: userGroup - - authId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + - authId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs id: demo2 permissions: [] settings: [] diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/users/get_declarative_users_user_groups.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/users/get_declarative_users_user_groups.yaml index eb06dca16..e2b6d6037 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/users/get_declarative_users_user_groups.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/users/get_declarative_users_user_groups.yaml @@ -68,7 +68,7 @@ interactions: userGroups: - id: adminGroup type: userGroup - - authId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + - authId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs email: demo@example.com firstname: Demo id: demo @@ -78,7 +78,7 @@ interactions: userGroups: - id: adminGroup type: userGroup - - authId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + - authId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs id: demo2 permissions: [] settings: [] @@ -151,7 +151,7 @@ interactions: userGroups: - id: adminGroup type: userGroup - - authId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + - authId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs email: demo@example.com firstname: Demo id: demo @@ -161,7 +161,7 @@ interactions: userGroups: - id: adminGroup type: userGroup - - authId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + - authId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs id: demo2 permissions: [] settings: [] diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/users/get_user.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/users/get_user.yaml index c9384e7cf..70309b376 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/users/get_user.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/users/get_user.yaml @@ -46,7 +46,7 @@ interactions: string: data: attributes: - authenticationId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + authenticationId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs id: demo2 relationships: userGroups: diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/users/list_users.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/users/list_users.yaml index 12af5ae00..5d20f7aa1 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/users/list_users.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/users/list_users.yaml @@ -56,7 +56,7 @@ interactions: type: userGroup type: user - attributes: - authenticationId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + authenticationId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs firstname: Demo lastname: User email: demo@example.com @@ -70,7 +70,7 @@ interactions: type: userGroup type: user - attributes: - authenticationId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + authenticationId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs id: demo2 links: self: http://localhost:3000/api/v1/entities/users/demo2 diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/users/load_and_put_declarative_user_groups.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/users/load_and_put_declarative_user_groups.yaml index d07e1a81a..e78456427 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/users/load_and_put_declarative_user_groups.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/users/load_and_put_declarative_user_groups.yaml @@ -51,7 +51,7 @@ interactions: userGroups: - id: adminGroup type: userGroup - - authId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + - authId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs email: demo@example.com firstname: Demo id: demo @@ -61,7 +61,7 @@ interactions: userGroups: - id: adminGroup type: userGroup - - authId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + - authId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs id: demo2 permissions: [] settings: [] @@ -181,7 +181,7 @@ interactions: type: userGroup type: user - attributes: - authenticationId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + authenticationId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs firstname: Demo lastname: User email: demo@example.com @@ -195,7 +195,7 @@ interactions: type: userGroup type: user - attributes: - authenticationId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + authenticationId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs id: demo2 links: self: http://localhost:3000/api/v1/entities/users/demo2 @@ -485,14 +485,14 @@ interactions: userGroups: - id: adminGroup permissions: [] - - id: demoGroup - name: demo group - permissions: [] - id: adminQA1Group parents: - id: adminGroup type: userGroup permissions: [] + - id: demoGroup + name: demo group + permissions: [] - id: visitorsGroup name: visitors parents: @@ -548,14 +548,14 @@ interactions: email: demo@example.com firstname: Demo lastname: User - authId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + authId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs userGroups: - id: adminGroup type: userGroup settings: [] permissions: [] - id: demo2 - authId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + authId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs userGroups: - id: demoGroup type: userGroup diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/users/load_and_put_declarative_users.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/users/load_and_put_declarative_users.yaml index a3880aa63..eb1f3c1be 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/users/load_and_put_declarative_users.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/users/load_and_put_declarative_users.yaml @@ -51,7 +51,7 @@ interactions: userGroups: - id: adminGroup type: userGroup - - authId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + - authId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs email: demo@example.com firstname: Demo id: demo @@ -61,7 +61,7 @@ interactions: userGroups: - id: adminGroup type: userGroup - - authId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + - authId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs id: demo2 permissions: [] settings: [] @@ -122,7 +122,7 @@ interactions: type: userGroup type: user - attributes: - authenticationId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + authenticationId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs firstname: Demo lastname: User email: demo@example.com @@ -136,7 +136,7 @@ interactions: type: userGroup type: user - attributes: - authenticationId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + authenticationId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs id: demo2 links: self: http://localhost:3000/api/v1/entities/users/demo2 @@ -399,14 +399,14 @@ interactions: email: demo@example.com firstname: Demo lastname: User - authId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + authId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs userGroups: - id: adminGroup type: userGroup settings: [] permissions: [] - id: demo2 - authId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + authId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs userGroups: - id: demoGroup type: userGroup diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/users/load_and_put_declarative_users_user_groups.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/users/load_and_put_declarative_users_user_groups.yaml index f8f8c28ff..87babe52d 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/users/load_and_put_declarative_users_user_groups.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/users/load_and_put_declarative_users_user_groups.yaml @@ -68,7 +68,7 @@ interactions: userGroups: - id: adminGroup type: userGroup - - authId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + - authId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs email: demo@example.com firstname: Demo id: demo @@ -78,7 +78,7 @@ interactions: userGroups: - id: adminGroup type: userGroup - - authId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + - authId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs id: demo2 permissions: [] settings: [] @@ -139,7 +139,7 @@ interactions: type: userGroup type: user - attributes: - authenticationId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + authenticationId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs firstname: Demo lastname: User email: demo@example.com @@ -153,7 +153,7 @@ interactions: type: userGroup type: user - attributes: - authenticationId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + authenticationId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs id: demo2 links: self: http://localhost:3000/api/v1/entities/users/demo2 @@ -510,14 +510,14 @@ interactions: email: demo@example.com firstname: Demo lastname: User - authId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + authId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs userGroups: - id: adminGroup type: userGroup settings: [] permissions: [] - id: demo2 - authId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + authId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs userGroups: - id: demoGroup type: userGroup diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/users/put_declarative_user_groups.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/users/put_declarative_user_groups.yaml index 33bd1eea0..ffcafebc4 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/users/put_declarative_user_groups.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/users/put_declarative_user_groups.yaml @@ -110,7 +110,7 @@ interactions: userGroups: - id: adminGroup type: userGroup - - authId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + - authId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs email: demo@example.com firstname: Demo id: demo @@ -120,7 +120,7 @@ interactions: userGroups: - id: adminGroup type: userGroup - - authId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + - authId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs id: demo2 permissions: [] settings: [] @@ -181,7 +181,7 @@ interactions: type: userGroup type: user - attributes: - authenticationId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + authenticationId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs firstname: Demo lastname: User email: demo@example.com @@ -195,7 +195,7 @@ interactions: type: userGroup type: user - attributes: - authenticationId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + authenticationId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs id: demo2 links: self: http://localhost:3000/api/v1/entities/users/demo2 @@ -384,14 +384,14 @@ interactions: userGroups: - id: adminGroup permissions: [] - - id: demoGroup - name: demo group - permissions: [] - id: adminQA1Group parents: - id: adminGroup type: userGroup permissions: [] + - id: demoGroup + name: demo group + permissions: [] - id: visitorsGroup name: visitors parents: @@ -447,14 +447,14 @@ interactions: email: demo@example.com firstname: Demo lastname: User - authId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + authId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs userGroups: - id: adminGroup type: userGroup settings: [] permissions: [] - id: demo2 - authId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + authId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs userGroups: - id: demoGroup type: userGroup diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/users/put_declarative_users.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/users/put_declarative_users.yaml index 8b2c1cd22..574d32d91 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/users/put_declarative_users.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/users/put_declarative_users.yaml @@ -51,7 +51,7 @@ interactions: userGroups: - id: adminGroup type: userGroup - - authId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + - authId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs email: demo@example.com firstname: Demo id: demo @@ -61,7 +61,7 @@ interactions: userGroups: - id: adminGroup type: userGroup - - authId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + - authId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs id: demo2 permissions: [] settings: [] @@ -122,7 +122,7 @@ interactions: type: userGroup type: user - attributes: - authenticationId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + authenticationId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs firstname: Demo lastname: User email: demo@example.com @@ -136,7 +136,7 @@ interactions: type: userGroup type: user - attributes: - authenticationId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + authenticationId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs id: demo2 links: self: http://localhost:3000/api/v1/entities/users/demo2 @@ -176,14 +176,14 @@ interactions: email: demo@example.com firstname: Demo lastname: User - authId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + authId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs userGroups: - id: adminGroup type: userGroup settings: [] permissions: [] - id: demo2 - authId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + authId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs userGroups: - id: demoGroup type: userGroup @@ -272,7 +272,7 @@ interactions: userGroups: - id: adminGroup type: userGroup - - authId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + - authId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs email: demo@example.com firstname: Demo id: demo @@ -282,7 +282,7 @@ interactions: userGroups: - id: adminGroup type: userGroup - - authId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + - authId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs id: demo2 permissions: [] settings: [] @@ -304,14 +304,14 @@ interactions: email: demo@example.com firstname: Demo lastname: User - authId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + authId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs userGroups: - id: adminGroup type: userGroup settings: [] permissions: [] - id: demo2 - authId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + authId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs userGroups: - id: demoGroup type: userGroup diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/users/put_declarative_users_user_groups.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/users/put_declarative_users_user_groups.yaml index 2e7c024da..cbf46e73f 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/users/put_declarative_users_user_groups.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/users/put_declarative_users_user_groups.yaml @@ -68,7 +68,7 @@ interactions: userGroups: - id: adminGroup type: userGroup - - authId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + - authId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs email: demo@example.com firstname: Demo id: demo @@ -78,7 +78,7 @@ interactions: userGroups: - id: adminGroup type: userGroup - - authId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + - authId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs id: demo2 permissions: [] settings: [] @@ -139,7 +139,7 @@ interactions: type: userGroup type: user - attributes: - authenticationId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + authenticationId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs firstname: Demo lastname: User email: demo@example.com @@ -153,7 +153,7 @@ interactions: type: userGroup type: user - attributes: - authenticationId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + authenticationId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs id: demo2 links: self: http://localhost:3000/api/v1/entities/users/demo2 @@ -253,14 +253,14 @@ interactions: email: demo@example.com firstname: Demo lastname: User - authId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + authId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs userGroups: - id: adminGroup type: userGroup settings: [] permissions: [] - id: demo2 - authId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + authId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs userGroups: - id: demoGroup type: userGroup @@ -366,7 +366,7 @@ interactions: userGroups: - id: adminGroup type: userGroup - - authId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + - authId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs email: demo@example.com firstname: Demo id: demo @@ -376,7 +376,7 @@ interactions: userGroups: - id: adminGroup type: userGroup - - authId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + - authId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs id: demo2 permissions: [] settings: [] @@ -415,14 +415,14 @@ interactions: email: demo@example.com firstname: Demo lastname: User - authId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + authId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs userGroups: - id: adminGroup type: userGroup settings: [] permissions: [] - id: demo2 - authId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + authId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs userGroups: - id: demoGroup type: userGroup diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/users/store_declarative_users.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/users/store_declarative_users.yaml index f40fc7c49..dc6460567 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/users/store_declarative_users.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/users/store_declarative_users.yaml @@ -51,7 +51,7 @@ interactions: userGroups: - id: adminGroup type: userGroup - - authId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + - authId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs email: demo@example.com firstname: Demo id: demo @@ -61,7 +61,7 @@ interactions: userGroups: - id: adminGroup type: userGroup - - authId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + - authId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs id: demo2 permissions: [] settings: [] @@ -117,7 +117,7 @@ interactions: userGroups: - id: adminGroup type: userGroup - - authId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + - authId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs email: demo@example.com firstname: Demo id: demo @@ -127,7 +127,7 @@ interactions: userGroups: - id: adminGroup type: userGroup - - authId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + - authId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs id: demo2 permissions: [] settings: [] diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/users/store_declarative_users_user_groups.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/users/store_declarative_users_user_groups.yaml index 69539fcdb..e46de2edc 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/users/store_declarative_users_user_groups.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/users/store_declarative_users_user_groups.yaml @@ -68,7 +68,7 @@ interactions: userGroups: - id: adminGroup type: userGroup - - authId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + - authId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs email: demo@example.com firstname: Demo id: demo @@ -78,7 +78,7 @@ interactions: userGroups: - id: adminGroup type: userGroup - - authId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + - authId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs id: demo2 permissions: [] settings: [] @@ -151,7 +151,7 @@ interactions: userGroups: - id: adminGroup type: userGroup - - authId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + - authId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs email: demo@example.com firstname: Demo id: demo @@ -161,7 +161,7 @@ interactions: userGroups: - id: adminGroup type: userGroup - - authId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + - authId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs id: demo2 permissions: [] settings: [] diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/users/test_api_tokens.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/users/test_api_tokens.yaml index 9974355da..9b53bbb01 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/users/test_api_tokens.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/users/test_api_tokens.yaml @@ -97,7 +97,7 @@ interactions: string: data: attributes: - bearerToken: ZGVtbzp0ZXN0X3Rva2VuOjRRUDBOell3czhSVGxhRzZDZ3NWM0NwWWtvZFRHaHNh + bearerToken: ZGVtbzp0ZXN0X3Rva2VuOjR2WS9XditRaXAwQ29oaGNlYS9LdWdwVXQ1KzRzMXdy id: test_token type: apiToken links: @@ -239,49 +239,3 @@ interactions: - '0' body: string: '' - - request: - method: GET - uri: http://localhost:3000/api/v1/entities/users/demo/apiTokens?page=0&size=500 - body: null - headers: - Accept: - - application/json - Accept-Encoding: - - br, gzip, deflate - X-GDC-VALIDATE-RELATIONS: - - 'true' - X-Requested-With: - - XMLHttpRequest - response: - status: - code: 200 - message: OK - headers: - Cache-Control: - - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '189' - Content-Type: - - application/json - DATE: *id001 - Expires: - - '0' - Pragma: - - no-cache - Referrer-Policy: - - no-referrer - Vary: - - Origin - - Access-Control-Request-Method - - Access-Control-Request-Headers - X-Content-Type-Options: - - nosniff - X-GDC-TRACE-ID: *id001 - X-Xss-Protection: - - '0' - body: - string: - data: [] - links: - self: http://localhost:3000/api/v1/entities/users/demo/apiTokens?page=0&size=500 - next: http://localhost:3000/api/v1/entities/users/demo/apiTokens?page=1&size=500 diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/users/test_user_add_user_group.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/users/test_user_add_user_group.yaml index c9384e7cf..70309b376 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/users/test_user_add_user_group.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/users/test_user_add_user_group.yaml @@ -46,7 +46,7 @@ interactions: string: data: attributes: - authenticationId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + authenticationId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs id: demo2 relationships: userGroups: diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/users/test_user_add_user_groups.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/users/test_user_add_user_groups.yaml index c9384e7cf..70309b376 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/users/test_user_add_user_groups.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/users/test_user_add_user_groups.yaml @@ -46,7 +46,7 @@ interactions: string: data: attributes: - authenticationId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + authenticationId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs id: demo2 relationships: userGroups: diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/users/test_user_remove_user_groups.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/users/test_user_remove_user_groups.yaml index c9384e7cf..70309b376 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/users/test_user_remove_user_groups.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/users/test_user_remove_user_groups.yaml @@ -46,7 +46,7 @@ interactions: string: data: attributes: - authenticationId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + authenticationId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs id: demo2 relationships: userGroups: diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/users/test_user_replace_user_groups.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/users/test_user_replace_user_groups.yaml index c9384e7cf..70309b376 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/users/test_user_replace_user_groups.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/users/test_user_replace_user_groups.yaml @@ -46,7 +46,7 @@ interactions: string: data: attributes: - authenticationId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + authenticationId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs id: demo2 relationships: userGroups: diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/users/update_user.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/users/update_user.yaml index 15bc02645..90a117526 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/users/update_user.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/users/update_user.yaml @@ -56,7 +56,7 @@ interactions: type: userGroup type: user - attributes: - authenticationId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + authenticationId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs firstname: Demo lastname: User email: demo@example.com @@ -70,7 +70,7 @@ interactions: type: userGroup type: user - attributes: - authenticationId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + authenticationId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs id: demo2 links: self: http://localhost:3000/api/v1/entities/users/demo2 @@ -141,7 +141,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: 846241483399aa221f8eaadb1e79fb42 + traceId: eff5dbbeb2d6e8b1f3f2b8cdae335454 - request: method: POST uri: http://localhost:3000/api/v1/entities/users @@ -263,7 +263,7 @@ interactions: type: userGroup type: user - attributes: - authenticationId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + authenticationId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs firstname: Demo lastname: User email: demo@example.com @@ -277,7 +277,7 @@ interactions: type: userGroup type: user - attributes: - authenticationId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs + authenticationId: CiQyZjk1MDEzYS1kY2FjLTQwMjgtYTM0Ny1iOGYyNjNhOGI2MzMSBWxvY2Fs id: demo2 links: self: http://localhost:3000/api/v1/entities/users/demo2 @@ -559,96 +559,3 @@ interactions: - '0' body: string: '' - - request: - method: GET - uri: http://localhost:3000/api/v1/entities/users?include=userGroups&page=0&size=500 - body: null - headers: - Accept: - - application/json - Accept-Encoding: - - br, gzip, deflate - X-GDC-VALIDATE-RELATIONS: - - 'true' - X-Requested-With: - - XMLHttpRequest - response: - status: - code: 200 - message: OK - headers: - Cache-Control: - - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '1302' - Content-Type: - - application/json - DATE: *id001 - Expires: - - '0' - Pragma: - - no-cache - Referrer-Policy: - - no-referrer - Vary: - - Origin - - Access-Control-Request-Method - - Access-Control-Request-Headers - X-Content-Type-Options: - - nosniff - X-GDC-TRACE-ID: *id001 - X-Xss-Protection: - - '0' - body: - string: - data: - - attributes: {} - id: admin - links: - self: http://localhost:3000/api/v1/entities/users/admin - relationships: - userGroups: - data: - - id: adminGroup - type: userGroup - type: user - - attributes: - authenticationId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs - firstname: Demo - lastname: User - email: demo@example.com - id: demo - links: - self: http://localhost:3000/api/v1/entities/users/demo - relationships: - userGroups: - data: - - id: adminGroup - type: userGroup - type: user - - attributes: - authenticationId: CiQwZjI2YzVkMS0zZDhlLTQ0N2ItYWJkNS1kNzE2NjRmODQxYzMSBWxvY2Fs - id: demo2 - links: - self: http://localhost:3000/api/v1/entities/users/demo2 - relationships: - userGroups: - data: - - id: demoGroup - type: userGroup - type: user - included: - - attributes: {} - id: adminGroup - links: - self: http://localhost:3000/api/v1/entities/userGroups/adminGroup - type: userGroup - - attributes: - name: demo group - id: demoGroup - links: - self: http://localhost:3000/api/v1/entities/userGroups/demoGroup - type: userGroup - links: - self: http://localhost:3000/api/v1/entities/users?include=userGroups&page=0&size=500 - next: http://localhost:3000/api/v1/entities/users?include=userGroups&page=1&size=500 diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/users/update_user_group.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/users/update_user_group.yaml index 1547b426f..55581a044 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/users/update_user_group.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/users/update_user_group.yaml @@ -51,96 +51,6 @@ interactions: type: userGroup links: self: http://localhost:3000/api/v1/entities/userGroups/demoGroup?include=ALL - - request: - method: GET - uri: http://localhost:3000/api/v1/entities/userGroups?include=userGroups&page=0&size=500 - body: null - headers: - Accept: - - application/json - Accept-Encoding: - - br, gzip, deflate - X-GDC-VALIDATE-RELATIONS: - - 'true' - X-Requested-With: - - XMLHttpRequest - response: - status: - code: 200 - message: OK - headers: - Cache-Control: - - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '1241' - Content-Type: - - application/json - DATE: *id001 - Expires: - - '0' - Pragma: - - no-cache - Referrer-Policy: - - no-referrer - Vary: - - Origin - - Access-Control-Request-Method - - Access-Control-Request-Headers - X-Content-Type-Options: - - nosniff - X-GDC-TRACE-ID: *id001 - X-Xss-Protection: - - '0' - body: - string: - data: - - attributes: {} - id: adminGroup - links: - self: http://localhost:3000/api/v1/entities/userGroups/adminGroup - type: userGroup - - attributes: {} - id: adminQA1Group - links: - self: http://localhost:3000/api/v1/entities/userGroups/adminQA1Group - relationships: - parents: - data: - - id: adminGroup - type: userGroup - type: userGroup - - attributes: - name: demo group - id: demoGroup - links: - self: http://localhost:3000/api/v1/entities/userGroups/demoGroup - type: userGroup - - attributes: - name: visitors - id: visitorsGroup - links: - self: http://localhost:3000/api/v1/entities/userGroups/visitorsGroup - relationships: - parents: - data: - - id: demoGroup - type: userGroup - type: userGroup - included: - - attributes: {} - id: adminGroup - links: - self: http://localhost:3000/api/v1/entities/userGroups/adminGroup - type: userGroup - - attributes: - name: demo group - id: demoGroup - links: - self: http://localhost:3000/api/v1/entities/userGroups/demoGroup - type: userGroup - links: - self: http://localhost:3000/api/v1/entities/userGroups?include=userGroups&page=0&size=500 - next: http://localhost:3000/api/v1/entities/userGroups?include=userGroups&page=1&size=500 - request: method: GET uri: http://localhost:3000/api/v1/entities/userGroups/demoGroup?include=ALL @@ -403,93 +313,3 @@ interactions: type: userGroup links: self: http://localhost:3000/api/v1/entities/userGroups/demoGroup - - request: - method: GET - uri: http://localhost:3000/api/v1/entities/userGroups?include=userGroups&page=0&size=500 - body: null - headers: - Accept: - - application/json - Accept-Encoding: - - br, gzip, deflate - X-GDC-VALIDATE-RELATIONS: - - 'true' - X-Requested-With: - - XMLHttpRequest - response: - status: - code: 200 - message: OK - headers: - Cache-Control: - - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '1241' - Content-Type: - - application/json - DATE: *id001 - Expires: - - '0' - Pragma: - - no-cache - Referrer-Policy: - - no-referrer - Vary: - - Origin - - Access-Control-Request-Method - - Access-Control-Request-Headers - X-Content-Type-Options: - - nosniff - X-GDC-TRACE-ID: *id001 - X-Xss-Protection: - - '0' - body: - string: - data: - - attributes: {} - id: adminGroup - links: - self: http://localhost:3000/api/v1/entities/userGroups/adminGroup - type: userGroup - - attributes: {} - id: adminQA1Group - links: - self: http://localhost:3000/api/v1/entities/userGroups/adminQA1Group - relationships: - parents: - data: - - id: adminGroup - type: userGroup - type: userGroup - - attributes: - name: demo group - id: demoGroup - links: - self: http://localhost:3000/api/v1/entities/userGroups/demoGroup - type: userGroup - - attributes: - name: visitors - id: visitorsGroup - links: - self: http://localhost:3000/api/v1/entities/userGroups/visitorsGroup - relationships: - parents: - data: - - id: demoGroup - type: userGroup - type: userGroup - included: - - attributes: {} - id: adminGroup - links: - self: http://localhost:3000/api/v1/entities/userGroups/adminGroup - type: userGroup - - attributes: - name: demo group - id: demoGroup - links: - self: http://localhost:3000/api/v1/entities/userGroups/demoGroup - type: userGroup - links: - self: http://localhost:3000/api/v1/entities/userGroups?include=userGroups&page=0&size=500 - next: http://localhost:3000/api/v1/entities/userGroups?include=userGroups&page=1&size=500 diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/analytics_store_load.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/analytics_store_load.yaml index 479c0f21b..0a64826e1 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/analytics_store_load.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/analytics_store_load.yaml @@ -94,7 +94,7 @@ interactions: drills: [] properties: {} version: '2' - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -137,7 +137,7 @@ interactions: type: dashboardPlugin version: '2' version: '2' - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -287,7 +287,7 @@ interactions: drills: [] properties: {} version: '2' - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -299,7 +299,7 @@ interactions: - content: url: https://www.example.com version: '2' - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -309,7 +309,7 @@ interactions: - content: url: https://www.example.com version: '2' - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -360,7 +360,7 @@ interactions: - content: format: '#,##0' maql: SELECT COUNT({attribute/customer_id},{attribute/order_line_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -369,7 +369,7 @@ interactions: - content: format: '#,##0' maql: SELECT COUNT({attribute/order_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -379,7 +379,7 @@ interactions: format: '#,##0' maql: 'SELECT {metric/amount_of_active_customers} WHERE (SELECT {metric/revenue} BY {attribute/customer_id}) > 10000 ' - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -389,7 +389,7 @@ interactions: format: '#,##0.00' maql: SELECT {metric/amount_of_orders} WHERE NOT ({label/order_status} IN ("Returned", "Canceled")) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -399,7 +399,7 @@ interactions: - content: format: $#,##0 maql: SELECT SUM({fact/spend}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -408,7 +408,7 @@ interactions: - content: format: $#,##0 maql: SELECT SUM({fact/price}*{fact/quantity}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -417,7 +417,7 @@ interactions: - content: format: '#,##0.0%' maql: SELECT {metric/revenue} / {metric/total_revenue} - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -427,7 +427,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10}\ \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -437,7 +437,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10_percent}\ \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -447,7 +447,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10_percent}\ \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -457,7 +457,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10}\ \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -467,7 +467,7 @@ interactions: format: '#,##0.0%' maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY {attribute/products.category}, ALL OTHER) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -477,7 +477,7 @@ interactions: format: '#,##0.0%' maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY ALL {attribute/product_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -487,7 +487,7 @@ interactions: format: $#,##0 maql: SELECT {metric/order_amount} WHERE NOT ({label/order_status} IN ("Returned", "Canceled")) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -498,7 +498,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Clothing") - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -508,7 +508,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ( "Electronics") - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -518,7 +518,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Home") - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -528,7 +528,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Outdoor") - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -537,7 +537,7 @@ interactions: - content: format: $#,##0.0 maql: SELECT AVG(SELECT {metric/revenue} BY {attribute/customer_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -546,7 +546,7 @@ interactions: - content: format: $#,##0.0 maql: SELECT {metric/revenue} / {metric/campaign_spend} - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -555,7 +555,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} WHERE TOP(10) OF ({metric/revenue}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -564,7 +564,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} WHERE TOP(10%) OF ({metric/revenue}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -573,7 +573,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} BY ALL OTHER - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -582,7 +582,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/total_revenue} WITHOUT PARENT FILTER - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -647,7 +647,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:treemap - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -723,7 +723,7 @@ interactions: rotation: auto version: '2' visualizationUrl: local:combo2 - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -802,7 +802,7 @@ interactions: direction: asc version: '2' visualizationUrl: local:table - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -861,7 +861,7 @@ interactions: stackMeasuresToPercent: true version: '2' visualizationUrl: local:area - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -918,7 +918,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:treemap - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -971,7 +971,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:donut - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1046,7 +1046,7 @@ interactions: visible: false version: '2' visualizationUrl: local:column - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1103,7 +1103,7 @@ interactions: enabled: true version: '2' visualizationUrl: local:scatter - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1202,7 +1202,7 @@ interactions: direction: asc version: '2' visualizationUrl: local:table - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1258,7 +1258,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:line - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1297,7 +1297,7 @@ interactions: properties: {} version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1353,7 +1353,7 @@ interactions: min: '0' version: '2' visualizationUrl: local:scatter - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1421,7 +1421,7 @@ interactions: rotation: auto version: '2' visualizationUrl: local:combo2 - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1478,7 +1478,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1535,7 +1535,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1633,7 +1633,7 @@ interactions: drills: [] properties: {} version: '2' - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1676,7 +1676,7 @@ interactions: type: dashboardPlugin version: '2' version: '2' - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1826,7 +1826,7 @@ interactions: drills: [] properties: {} version: '2' - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1838,7 +1838,7 @@ interactions: - content: url: https://www.example.com version: '2' - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1848,7 +1848,7 @@ interactions: - content: url: https://www.example.com version: '2' - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1899,7 +1899,7 @@ interactions: - content: format: '#,##0' maql: SELECT COUNT({attribute/customer_id},{attribute/order_line_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1908,7 +1908,7 @@ interactions: - content: format: '#,##0' maql: SELECT COUNT({attribute/order_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1918,7 +1918,7 @@ interactions: format: '#,##0' maql: 'SELECT {metric/amount_of_active_customers} WHERE (SELECT {metric/revenue} BY {attribute/customer_id}) > 10000 ' - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1928,7 +1928,7 @@ interactions: format: '#,##0.00' maql: SELECT {metric/amount_of_orders} WHERE NOT ({label/order_status} IN ("Returned", "Canceled")) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1938,7 +1938,7 @@ interactions: - content: format: $#,##0 maql: SELECT SUM({fact/spend}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1947,7 +1947,7 @@ interactions: - content: format: $#,##0 maql: SELECT SUM({fact/price}*{fact/quantity}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1956,7 +1956,7 @@ interactions: - content: format: '#,##0.0%' maql: SELECT {metric/revenue} / {metric/total_revenue} - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1966,7 +1966,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10}\ \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1976,7 +1976,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10_percent}\ \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1986,7 +1986,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10_percent}\ \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1996,7 +1996,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10}\ \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2006,7 +2006,7 @@ interactions: format: '#,##0.0%' maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY {attribute/products.category}, ALL OTHER) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2016,7 +2016,7 @@ interactions: format: '#,##0.0%' maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY ALL {attribute/product_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2026,7 +2026,7 @@ interactions: format: $#,##0 maql: SELECT {metric/order_amount} WHERE NOT ({label/order_status} IN ("Returned", "Canceled")) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2037,7 +2037,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Clothing") - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2047,7 +2047,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ( "Electronics") - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2057,7 +2057,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Home") - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2067,7 +2067,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Outdoor") - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2076,7 +2076,7 @@ interactions: - content: format: $#,##0.0 maql: SELECT AVG(SELECT {metric/revenue} BY {attribute/customer_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2085,7 +2085,7 @@ interactions: - content: format: $#,##0.0 maql: SELECT {metric/revenue} / {metric/campaign_spend} - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2094,7 +2094,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} WHERE TOP(10) OF ({metric/revenue}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2103,7 +2103,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} WHERE TOP(10%) OF ({metric/revenue}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2112,7 +2112,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} BY ALL OTHER - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2121,7 +2121,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/total_revenue} WITHOUT PARENT FILTER - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2186,7 +2186,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:treemap - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2262,7 +2262,7 @@ interactions: rotation: auto version: '2' visualizationUrl: local:combo2 - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2341,7 +2341,7 @@ interactions: direction: asc version: '2' visualizationUrl: local:table - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2400,7 +2400,7 @@ interactions: stackMeasuresToPercent: true version: '2' visualizationUrl: local:area - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2457,7 +2457,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:treemap - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2510,7 +2510,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:donut - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2585,7 +2585,7 @@ interactions: visible: false version: '2' visualizationUrl: local:column - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2642,7 +2642,7 @@ interactions: enabled: true version: '2' visualizationUrl: local:scatter - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2741,7 +2741,7 @@ interactions: direction: asc version: '2' visualizationUrl: local:table - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2797,7 +2797,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:line - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2836,7 +2836,7 @@ interactions: properties: {} version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2892,7 +2892,7 @@ interactions: min: '0' version: '2' visualizationUrl: local:scatter - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2960,7 +2960,7 @@ interactions: rotation: auto version: '2' visualizationUrl: local:combo2 - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3017,7 +3017,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3074,7 +3074,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_catalog.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_catalog.yaml index 3736945bc..39d3fdbbe 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_catalog.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_catalog.yaml @@ -516,10 +516,10 @@ interactions: type: dataset labels: data: - - id: state - type: label - id: geo__state__location type: label + - id: state + type: label type: attribute - attributes: title: Type @@ -583,28 +583,28 @@ interactions: type: attribute referenceProperties: - identifier: - id: campaigns + id: products type: dataset multivalue: false sources: - - column: campaign_id + - column: product_id dataType: INT target: - id: campaign_id + id: product_id type: attribute isNullable: null nullValue: null sourceColumns: null sourceColumnDataTypes: null - identifier: - id: customers + id: campaigns type: dataset multivalue: false sources: - - column: customer_id + - column: campaign_id dataType: INT target: - id: customer_id + id: campaign_id type: attribute isNullable: null nullValue: null @@ -625,14 +625,14 @@ interactions: sourceColumns: null sourceColumnDataTypes: null - identifier: - id: products + id: customers type: dataset multivalue: false sources: - - column: product_id + - column: customer_id dataType: INT target: - id: product_id + id: customer_id type: attribute isNullable: null nullValue: null @@ -1231,28 +1231,28 @@ interactions: type: attribute referenceProperties: - identifier: - id: campaigns + id: products type: dataset multivalue: false sources: - - column: campaign_id + - column: product_id dataType: INT target: - id: campaign_id + id: product_id type: attribute isNullable: null nullValue: null sourceColumns: null sourceColumnDataTypes: null - identifier: - id: customers + id: campaigns type: dataset multivalue: false sources: - - column: customer_id + - column: campaign_id dataType: INT target: - id: customer_id + id: campaign_id type: attribute isNullable: null nullValue: null @@ -1273,14 +1273,14 @@ interactions: sourceColumns: null sourceColumnDataTypes: null - identifier: - id: products + id: customers type: dataset multivalue: false sources: - - column: product_id + - column: customer_id dataType: INT target: - id: product_id + id: customer_id type: attribute isNullable: null nullValue: null @@ -1685,7 +1685,7 @@ interactions: content: format: '#,##0' maql: SELECT COUNT({attribute/customer_id},{attribute/order_line_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: amount_of_active_customers links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/amount_of_active_customers @@ -1700,7 +1700,7 @@ interactions: content: format: '#,##0' maql: SELECT COUNT({attribute/order_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: amount_of_orders links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/amount_of_orders @@ -1716,7 +1716,7 @@ interactions: format: '#,##0' maql: 'SELECT {metric/amount_of_active_customers} WHERE (SELECT {metric/revenue} BY {attribute/customer_id}) > 10000 ' - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: amount_of_top_customers links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/amount_of_top_customers @@ -1733,7 +1733,7 @@ interactions: format: '#,##0.00' maql: SELECT {metric/amount_of_orders} WHERE NOT ({label/order_status} IN ("Returned", "Canceled")) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: amount_of_valid_orders links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/amount_of_valid_orders @@ -1748,7 +1748,7 @@ interactions: content: format: $#,##0 maql: SELECT SUM({fact/spend}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: campaign_spend links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/campaign_spend @@ -1763,7 +1763,7 @@ interactions: content: format: $#,##0 maql: SELECT SUM({fact/price}*{fact/quantity}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: order_amount links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/order_amount @@ -1778,7 +1778,7 @@ interactions: content: format: '#,##0.0%' maql: SELECT {metric/revenue} / {metric/total_revenue} - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: percent_revenue links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/percent_revenue @@ -1794,7 +1794,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10}\ \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: percent_revenue_from_top_10_customers links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/percent_revenue_from_top_10_customers @@ -1810,7 +1810,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10_percent}\ \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: percent_revenue_from_top_10_percent_customers links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/percent_revenue_from_top_10_percent_customers @@ -1826,7 +1826,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10_percent}\ \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: percent_revenue_from_top_10_percent_products links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/percent_revenue_from_top_10_percent_products @@ -1842,7 +1842,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10}\ \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: percent_revenue_from_top_10_products links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/percent_revenue_from_top_10_products @@ -1858,7 +1858,7 @@ interactions: format: '#,##0.0%' maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY {attribute/products.category}, ALL OTHER) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: percent_revenue_in_category links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/percent_revenue_in_category @@ -1874,7 +1874,7 @@ interactions: format: '#,##0.0%' maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY ALL {attribute/product_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: percent_revenue_per_product links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/percent_revenue_per_product @@ -1891,7 +1891,7 @@ interactions: format: $#,##0 maql: SELECT {metric/order_amount} WHERE NOT ({label/order_status} IN ("Returned", "Canceled")) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue @@ -1907,7 +1907,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Clothing") - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue-clothing links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue-clothing @@ -1923,7 +1923,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ( "Electronics") - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue-electronic links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue-electronic @@ -1939,7 +1939,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Home") - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue-home links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue-home @@ -1955,7 +1955,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Outdoor") - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue-outdoor links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue-outdoor @@ -1970,7 +1970,7 @@ interactions: content: format: $#,##0.0 maql: SELECT AVG(SELECT {metric/revenue} BY {attribute/customer_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue_per_customer links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue_per_customer @@ -1985,7 +1985,7 @@ interactions: content: format: $#,##0.0 maql: SELECT {metric/revenue} / {metric/campaign_spend} - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue_per_dollar_spent links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue_per_dollar_spent @@ -2000,7 +2000,7 @@ interactions: content: format: $#,##0 maql: SELECT {metric/revenue} WHERE TOP(10) OF ({metric/revenue}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue_top_10 links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue_top_10 @@ -2015,7 +2015,7 @@ interactions: content: format: $#,##0 maql: SELECT {metric/revenue} WHERE TOP(10%) OF ({metric/revenue}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue_top_10_percent links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue_top_10_percent @@ -2030,7 +2030,7 @@ interactions: content: format: $#,##0 maql: SELECT {metric/revenue} BY ALL OTHER - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: total_revenue links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/total_revenue @@ -2045,7 +2045,7 @@ interactions: content: format: $#,##0 maql: SELECT {metric/total_revenue} WITHOUT PARENT FILTER - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: total_revenue-no_filters links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/total_revenue-no_filters diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_catalog_availability.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_catalog_availability.yaml index 27ec346bc..5dcd72bad 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_catalog_availability.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_catalog_availability.yaml @@ -516,10 +516,10 @@ interactions: type: dataset labels: data: - - id: state - type: label - id: geo__state__location type: label + - id: state + type: label type: attribute - attributes: title: Type @@ -583,28 +583,28 @@ interactions: type: attribute referenceProperties: - identifier: - id: campaigns + id: products type: dataset multivalue: false sources: - - column: campaign_id + - column: product_id dataType: INT target: - id: campaign_id + id: product_id type: attribute isNullable: null nullValue: null sourceColumns: null sourceColumnDataTypes: null - identifier: - id: customers + id: campaigns type: dataset multivalue: false sources: - - column: customer_id + - column: campaign_id dataType: INT target: - id: customer_id + id: campaign_id type: attribute isNullable: null nullValue: null @@ -625,14 +625,14 @@ interactions: sourceColumns: null sourceColumnDataTypes: null - identifier: - id: products + id: customers type: dataset multivalue: false sources: - - column: product_id + - column: customer_id dataType: INT target: - id: product_id + id: customer_id type: attribute isNullable: null nullValue: null @@ -1231,28 +1231,28 @@ interactions: type: attribute referenceProperties: - identifier: - id: campaigns + id: products type: dataset multivalue: false sources: - - column: campaign_id + - column: product_id dataType: INT target: - id: campaign_id + id: product_id type: attribute isNullable: null nullValue: null sourceColumns: null sourceColumnDataTypes: null - identifier: - id: customers + id: campaigns type: dataset multivalue: false sources: - - column: customer_id + - column: campaign_id dataType: INT target: - id: customer_id + id: campaign_id type: attribute isNullable: null nullValue: null @@ -1273,14 +1273,14 @@ interactions: sourceColumns: null sourceColumnDataTypes: null - identifier: - id: products + id: customers type: dataset multivalue: false sources: - - column: product_id + - column: customer_id dataType: INT target: - id: product_id + id: customer_id type: attribute isNullable: null nullValue: null @@ -1685,7 +1685,7 @@ interactions: content: format: '#,##0' maql: SELECT COUNT({attribute/customer_id},{attribute/order_line_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: amount_of_active_customers links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/amount_of_active_customers @@ -1700,7 +1700,7 @@ interactions: content: format: '#,##0' maql: SELECT COUNT({attribute/order_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: amount_of_orders links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/amount_of_orders @@ -1716,7 +1716,7 @@ interactions: format: '#,##0' maql: 'SELECT {metric/amount_of_active_customers} WHERE (SELECT {metric/revenue} BY {attribute/customer_id}) > 10000 ' - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: amount_of_top_customers links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/amount_of_top_customers @@ -1733,7 +1733,7 @@ interactions: format: '#,##0.00' maql: SELECT {metric/amount_of_orders} WHERE NOT ({label/order_status} IN ("Returned", "Canceled")) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: amount_of_valid_orders links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/amount_of_valid_orders @@ -1748,7 +1748,7 @@ interactions: content: format: $#,##0 maql: SELECT SUM({fact/spend}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: campaign_spend links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/campaign_spend @@ -1763,7 +1763,7 @@ interactions: content: format: $#,##0 maql: SELECT SUM({fact/price}*{fact/quantity}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: order_amount links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/order_amount @@ -1778,7 +1778,7 @@ interactions: content: format: '#,##0.0%' maql: SELECT {metric/revenue} / {metric/total_revenue} - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: percent_revenue links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/percent_revenue @@ -1794,7 +1794,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10}\ \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: percent_revenue_from_top_10_customers links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/percent_revenue_from_top_10_customers @@ -1810,7 +1810,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10_percent}\ \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: percent_revenue_from_top_10_percent_customers links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/percent_revenue_from_top_10_percent_customers @@ -1826,7 +1826,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10_percent}\ \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: percent_revenue_from_top_10_percent_products links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/percent_revenue_from_top_10_percent_products @@ -1842,7 +1842,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10}\ \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: percent_revenue_from_top_10_products links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/percent_revenue_from_top_10_products @@ -1858,7 +1858,7 @@ interactions: format: '#,##0.0%' maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY {attribute/products.category}, ALL OTHER) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: percent_revenue_in_category links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/percent_revenue_in_category @@ -1874,7 +1874,7 @@ interactions: format: '#,##0.0%' maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY ALL {attribute/product_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: percent_revenue_per_product links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/percent_revenue_per_product @@ -1891,7 +1891,7 @@ interactions: format: $#,##0 maql: SELECT {metric/order_amount} WHERE NOT ({label/order_status} IN ("Returned", "Canceled")) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue @@ -1907,7 +1907,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Clothing") - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue-clothing links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue-clothing @@ -1923,7 +1923,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ( "Electronics") - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue-electronic links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue-electronic @@ -1939,7 +1939,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Home") - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue-home links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue-home @@ -1955,7 +1955,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Outdoor") - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue-outdoor links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue-outdoor @@ -1970,7 +1970,7 @@ interactions: content: format: $#,##0.0 maql: SELECT AVG(SELECT {metric/revenue} BY {attribute/customer_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue_per_customer links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue_per_customer @@ -1985,7 +1985,7 @@ interactions: content: format: $#,##0.0 maql: SELECT {metric/revenue} / {metric/campaign_spend} - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue_per_dollar_spent links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue_per_dollar_spent @@ -2000,7 +2000,7 @@ interactions: content: format: $#,##0 maql: SELECT {metric/revenue} WHERE TOP(10) OF ({metric/revenue}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue_top_10 links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue_top_10 @@ -2015,7 +2015,7 @@ interactions: content: format: $#,##0 maql: SELECT {metric/revenue} WHERE TOP(10%) OF ({metric/revenue}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue_top_10_percent links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue_top_10_percent @@ -2030,7 +2030,7 @@ interactions: content: format: $#,##0 maql: SELECT {metric/revenue} BY ALL OTHER - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: total_revenue links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/total_revenue @@ -2045,7 +2045,7 @@ interactions: content: format: $#,##0 maql: SELECT {metric/total_revenue} WITHOUT PARENT FILTER - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: total_revenue-no_filters links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/total_revenue-no_filters diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_catalog_list_attributes.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_catalog_list_attributes.yaml index bc4ded0ac..d74d00cfd 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_catalog_list_attributes.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_catalog_list_attributes.yaml @@ -436,10 +436,10 @@ interactions: relationships: labels: data: - - id: state - type: label - id: geo__state__location type: label + - id: state + type: label type: attribute - attributes: title: Type diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_catalog_list_metrics.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_catalog_list_metrics.yaml index 6d9c3c499..2307b3785 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_catalog_list_metrics.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_catalog_list_metrics.yaml @@ -51,7 +51,7 @@ interactions: content: format: '#,##0' maql: SELECT COUNT({attribute/customer_id},{attribute/order_line_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: amount_of_active_customers links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/amount_of_active_customers @@ -66,7 +66,7 @@ interactions: content: format: '#,##0' maql: SELECT COUNT({attribute/order_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: amount_of_orders links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/amount_of_orders @@ -82,7 +82,7 @@ interactions: format: '#,##0' maql: 'SELECT {metric/amount_of_active_customers} WHERE (SELECT {metric/revenue} BY {attribute/customer_id}) > 10000 ' - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: amount_of_top_customers links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/amount_of_top_customers @@ -99,7 +99,7 @@ interactions: format: '#,##0.00' maql: SELECT {metric/amount_of_orders} WHERE NOT ({label/order_status} IN ("Returned", "Canceled")) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: amount_of_valid_orders links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/amount_of_valid_orders @@ -114,7 +114,7 @@ interactions: content: format: $#,##0 maql: SELECT SUM({fact/spend}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: campaign_spend links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/campaign_spend @@ -129,7 +129,7 @@ interactions: content: format: $#,##0 maql: SELECT SUM({fact/price}*{fact/quantity}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: order_amount links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/order_amount @@ -144,7 +144,7 @@ interactions: content: format: '#,##0.0%' maql: SELECT {metric/revenue} / {metric/total_revenue} - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: percent_revenue links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/percent_revenue @@ -160,7 +160,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10}\ \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: percent_revenue_from_top_10_customers links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/percent_revenue_from_top_10_customers @@ -176,7 +176,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10_percent}\ \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: percent_revenue_from_top_10_percent_customers links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/percent_revenue_from_top_10_percent_customers @@ -192,7 +192,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10_percent}\ \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: percent_revenue_from_top_10_percent_products links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/percent_revenue_from_top_10_percent_products @@ -208,7 +208,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10}\ \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: percent_revenue_from_top_10_products links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/percent_revenue_from_top_10_products @@ -224,7 +224,7 @@ interactions: format: '#,##0.0%' maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY {attribute/products.category}, ALL OTHER) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: percent_revenue_in_category links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/percent_revenue_in_category @@ -240,7 +240,7 @@ interactions: format: '#,##0.0%' maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY ALL {attribute/product_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: percent_revenue_per_product links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/percent_revenue_per_product @@ -257,7 +257,7 @@ interactions: format: $#,##0 maql: SELECT {metric/order_amount} WHERE NOT ({label/order_status} IN ("Returned", "Canceled")) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue @@ -273,7 +273,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Clothing") - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue-clothing links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue-clothing @@ -289,7 +289,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ( "Electronics") - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue-electronic links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue-electronic @@ -305,7 +305,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Home") - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue-home links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue-home @@ -321,7 +321,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Outdoor") - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue-outdoor links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue-outdoor @@ -336,7 +336,7 @@ interactions: content: format: $#,##0.0 maql: SELECT AVG(SELECT {metric/revenue} BY {attribute/customer_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue_per_customer links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue_per_customer @@ -351,7 +351,7 @@ interactions: content: format: $#,##0.0 maql: SELECT {metric/revenue} / {metric/campaign_spend} - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue_per_dollar_spent links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue_per_dollar_spent @@ -366,7 +366,7 @@ interactions: content: format: $#,##0 maql: SELECT {metric/revenue} WHERE TOP(10) OF ({metric/revenue}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue_top_10 links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue_top_10 @@ -381,7 +381,7 @@ interactions: content: format: $#,##0 maql: SELECT {metric/revenue} WHERE TOP(10%) OF ({metric/revenue}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue_top_10_percent links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue_top_10_percent @@ -396,7 +396,7 @@ interactions: content: format: $#,##0 maql: SELECT {metric/revenue} BY ALL OTHER - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: total_revenue links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/total_revenue @@ -411,7 +411,7 @@ interactions: content: format: $#,##0 maql: SELECT {metric/total_revenue} WITHOUT PARENT FILTER - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: total_revenue-no_filters links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/total_revenue-no_filters diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_get_dependent_entities_graph.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_get_dependent_entities_graph.yaml index d19afbcfe..d7aa816ae 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_get_dependent_entities_graph.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_get_dependent_entities_graph.yaml @@ -64,27 +64,27 @@ interactions: type: dataset - - id: customer_id type: attribute - - id: percent_revenue_from_top_10_customers + - id: amount_of_active_customers type: metric - - id: customer_id type: attribute - - id: revenue_per_customer + - id: percent_revenue_from_top_10_percent_customers type: metric - - - id: customer_id - type: attribute - - id: customers - type: dataset - - id: customer_id type: attribute - id: amount_of_top_customers type: metric - - id: customer_id type: attribute - - id: amount_of_active_customers + - id: revenue_per_customer type: metric - - id: customer_id type: attribute - - id: percent_revenue_from_top_10_percent_customers + - id: customers + type: dataset + - - id: customer_id + type: attribute + - id: percent_revenue_from_top_10_customers type: metric - - id: customer_name type: attribute @@ -114,26 +114,30 @@ interactions: type: attribute - id: date type: dataset - - - id: order_id - type: attribute - - id: amount_of_orders - type: metric - - id: order_id type: attribute - id: order_lines type: dataset - - - id: order_line_id + - - id: order_id type: attribute - - id: order_lines - type: dataset + - id: amount_of_orders + type: metric - - id: order_line_id type: attribute - id: amount_of_active_customers type: metric + - - id: order_line_id + type: attribute + - id: order_lines + type: dataset - - id: order_status type: attribute - id: order_lines type: dataset + - - id: product_id + type: attribute + - id: percent_revenue_from_top_10_products + type: metric - - id: product_id type: attribute - id: percent_revenue_per_product @@ -142,10 +146,6 @@ interactions: type: attribute - id: products type: dataset - - - id: product_id - type: attribute - - id: percent_revenue_from_top_10_products - type: metric - - id: product_id type: attribute - id: percent_revenue_from_top_10_percent_products @@ -154,14 +154,14 @@ interactions: type: attribute - id: products type: dataset - - - id: products.category - type: attribute - - id: percent_revenue_in_category - type: metric - - id: products.category type: attribute - id: products type: dataset + - - id: products.category + type: attribute + - id: percent_revenue_in_category + type: metric - - id: region type: attribute - id: customers @@ -196,20 +196,20 @@ interactions: type: dataset - - id: date type: dataset - - id: customers_trend + - id: percentage_of_customers_by_region type: visualizationObject - - id: date type: dataset - - id: revenue_trend + - id: product_revenue_comparison-over_previous_period type: visualizationObject - - id: date type: dataset - - id: percentage_of_customers_by_region + - id: customers_trend type: visualizationObject - - id: date type: dataset - - id: product_revenue_comparison-over_previous_period - type: visualizationObject + - id: product_and_category + type: analyticalDashboard - - id: date type: dataset - id: revenue_by_category_trend @@ -220,8 +220,8 @@ interactions: type: dataset - - id: date type: dataset - - id: product_and_category - type: analyticalDashboard + - id: revenue_trend + type: visualizationObject - - id: products type: dataset - id: order_lines @@ -278,6 +278,10 @@ interactions: type: label - id: campaign_id type: attribute + - - id: campaign_name + type: label + - id: revenue_per_usd_vs_spend_by_campaign + type: visualizationObject - - id: campaign_name type: label - id: campaign_name @@ -290,18 +294,10 @@ interactions: type: label - id: campaign_name_filter type: filterContext - - - id: campaign_name - type: label - - id: revenue_per_usd_vs_spend_by_campaign - type: visualizationObject - - id: customer_id type: label - id: customer_id type: attribute - - - id: customer_name - type: label - - id: revenue_and_quantity_by_product_and_category - type: visualizationObject - - id: customer_name type: label - id: customer_name @@ -310,6 +306,10 @@ interactions: type: label - id: percent_revenue_per_product_by_customer_and_category type: visualizationObject + - - id: customer_name + type: label + - id: revenue_and_quantity_by_product_and_category + type: visualizationObject - - id: customer_name type: label - id: top_10_customers @@ -320,15 +320,11 @@ interactions: type: attribute - - id: date.month type: label - - id: customers_trend - type: visualizationObject - - - id: date.month - type: label - - id: revenue_trend + - id: percentage_of_customers_by_region type: visualizationObject - - id: date.month type: label - - id: percentage_of_customers_by_region + - id: customers_trend type: visualizationObject - - id: date.month type: label @@ -338,6 +334,10 @@ interactions: type: label - id: date.month type: attribute + - - id: date.month + type: label + - id: revenue_trend + type: visualizationObject - - id: date.quarter type: label - id: date.quarter @@ -362,14 +362,14 @@ interactions: type: label - id: order_line_id type: attribute - - - id: order_status - type: label - - id: amount_of_valid_orders - type: metric - - id: order_status type: label - id: order_status type: attribute + - - id: order_status + type: label + - id: amount_of_valid_orders + type: metric - - id: order_status type: label - id: revenue @@ -380,7 +380,7 @@ interactions: type: attribute - - id: product_name type: label - - id: revenue_by_product + - id: product_revenue_comparison-over_previous_period type: visualizationObject - - id: product_name type: label @@ -388,11 +388,11 @@ interactions: type: attribute - - id: product_name type: label - - id: product_revenue_comparison-over_previous_period + - id: percent_revenue_per_product_by_customer_and_category type: visualizationObject - - id: product_name type: label - - id: product_breakdown + - id: product_categories_pie_chart type: visualizationObject - - id: product_name type: label @@ -400,19 +400,23 @@ interactions: type: visualizationObject - - id: product_name type: label - - id: product_categories_pie_chart + - id: product_saleability type: visualizationObject - - id: product_name type: label - - id: revenue_and_quantity_by_product_and_category + - id: product_breakdown type: visualizationObject - - id: product_name type: label - - id: percent_revenue_per_product_by_customer_and_category + - id: revenue_and_quantity_by_product_and_category type: visualizationObject - - id: product_name type: label - - id: product_saleability + - id: revenue_by_product + type: visualizationObject + - - id: products.category + type: label + - id: product_revenue_comparison-over_previous_period type: visualizationObject - - id: products.category type: label @@ -420,48 +424,44 @@ interactions: type: metric - - id: products.category type: label - - id: product_revenue_comparison-over_previous_period - type: visualizationObject + - id: revenue-outdoor + type: metric - - id: products.category type: label - - id: product_breakdown - type: visualizationObject + - id: revenue-electronic + type: metric - - id: products.category type: label - - id: revenue_by_category_trend + - id: percent_revenue_per_product_by_customer_and_category type: visualizationObject - - id: products.category type: label - - id: top_10_products + - id: product_categories_pie_chart type: visualizationObject - - id: products.category type: label - - id: revenue-outdoor - type: metric - - - id: products.category - type: label - - id: revenue-clothing - type: metric + - id: products.category + type: attribute - - id: products.category type: label - - id: product_categories_pie_chart + - id: top_10_products type: visualizationObject - - id: products.category type: label - - id: revenue-electronic - type: metric + - id: revenue_by_category_trend + type: visualizationObject - - id: products.category type: label - - id: revenue_and_quantity_by_product_and_category + - id: product_breakdown type: visualizationObject - - id: products.category type: label - - id: percent_revenue_per_product_by_customer_and_category + - id: revenue_and_quantity_by_product_and_category type: visualizationObject - - id: products.category type: label - - id: products.category - type: attribute + - id: revenue-clothing + type: metric - - id: region type: label - id: region @@ -492,16 +492,20 @@ interactions: type: visualizationObject - - id: amount_of_active_customers type: metric - - id: customers_trend + - id: percentage_of_customers_by_region type: visualizationObject - - id: amount_of_active_customers type: metric - - id: percentage_of_customers_by_region + - id: customers_trend type: visualizationObject - - id: amount_of_active_customers type: metric - id: amount_of_top_customers type: metric + - - id: amount_of_orders + type: metric + - id: product_saleability + type: visualizationObject - - id: amount_of_orders type: metric - id: amount_of_valid_orders @@ -510,21 +514,17 @@ interactions: type: metric - id: revenue_trend type: visualizationObject - - - id: amount_of_orders - type: metric - - id: product_saleability - type: visualizationObject - - id: campaign_spend type: metric - id: revenue_per_dollar_spent type: metric - - id: campaign_spend type: metric - - id: campaign_spend + - id: revenue_per_usd_vs_spend_by_campaign type: visualizationObject - - id: campaign_spend type: metric - - id: revenue_per_usd_vs_spend_by_campaign + - id: campaign_spend type: visualizationObject - - id: order_amount type: metric @@ -544,104 +544,104 @@ interactions: type: metric - - id: revenue type: metric - - id: product_revenue_comparison-over_previous_period - type: visualizationObject + - id: percent_revenue_from_top_10_percent_products + type: metric - - id: revenue type: metric - id: revenue-outdoor type: metric - - id: revenue type: metric - - id: percent_revenue_from_top_10_percent_products - type: metric + - id: revenue_by_category_trend + type: visualizationObject - - id: revenue type: metric - - id: revenue-clothing - type: metric + - id: product_breakdown + type: visualizationObject - - id: revenue type: metric - - id: percent_revenue_in_category + - id: revenue_and_quantity_by_product_and_category + type: visualizationObject + - - id: revenue type: metric + - id: product_revenue_comparison-over_previous_period + type: visualizationObject - - id: revenue type: metric - - id: total_revenue + - id: percent_revenue_from_top_10_percent_customers type: metric - - id: revenue type: metric - - id: percent_revenue_per_product_by_customer_and_category - type: visualizationObject + - id: percent_revenue_per_product + type: metric - - id: revenue type: metric - - id: percent_revenue_from_top_10_customers + - id: amount_of_top_customers type: metric - - id: revenue type: metric - - id: revenue_per_dollar_spent + - id: percent_revenue type: metric - - id: revenue type: metric - - id: percent_revenue_from_top_10_products + - id: revenue_top_10_percent type: metric - - id: revenue type: metric - - id: product_saleability - type: visualizationObject + - id: revenue_per_customer + type: metric - - id: revenue type: metric - - id: revenue_top_10 + - id: revenue-electronic type: metric - - id: revenue type: metric - - id: revenue_by_product + - id: percent_revenue_per_product_by_customer_and_category type: visualizationObject - - id: revenue type: metric - - id: revenue_trend + - id: product_categories_pie_chart type: visualizationObject - - id: revenue type: metric - - id: percent_revenue_per_product + - id: percent_revenue_in_category type: metric - - id: revenue type: metric - - id: product_breakdown - type: visualizationObject - - - id: revenue + - id: percent_revenue_from_top_10_products type: metric - - id: revenue_by_category_trend - type: visualizationObject - - id: revenue type: metric - - id: revenue_per_customer + - id: revenue_top_10 type: metric - - id: revenue type: metric - - id: amount_of_top_customers - type: metric + - id: product_saleability + type: visualizationObject - - id: revenue type: metric - - id: percent_revenue + - id: revenue_per_dollar_spent type: metric - - id: revenue type: metric - - id: revenue_top_10_percent + - id: total_revenue type: metric - - id: revenue type: metric - - id: product_categories_pie_chart - type: visualizationObject + - id: percent_revenue_from_top_10_customers + type: metric - - id: revenue type: metric - - id: revenue-electronic + - id: revenue-clothing type: metric - - id: revenue type: metric - - id: revenue_and_quantity_by_product_and_category + - id: revenue_by_product type: visualizationObject - - id: revenue type: metric - - id: percent_revenue_from_top_10_percent_customers - type: metric + - id: revenue_trend + type: visualizationObject - - id: revenue_per_customer type: metric - id: customers_trend @@ -652,20 +652,20 @@ interactions: type: visualizationObject - - id: revenue_top_10 type: metric - - id: percent_revenue_from_top_10_customers + - id: percent_revenue_from_top_10_products type: metric - - id: revenue_top_10 type: metric - - id: top_10_products + - id: top_10_customers type: visualizationObject - - id: revenue_top_10 type: metric - - id: percent_revenue_from_top_10_products - type: metric + - id: top_10_products + type: visualizationObject - - id: revenue_top_10 type: metric - - id: top_10_customers - type: visualizationObject + - id: percent_revenue_from_top_10_customers + type: metric - - id: revenue_top_10_percent type: metric - id: percent_revenue_from_top_10_percent_products @@ -676,11 +676,11 @@ interactions: type: metric - - id: total_revenue type: metric - - id: percent_revenue + - id: total_revenue-no_filters type: metric - - id: total_revenue type: metric - - id: total_revenue-no_filters + - id: percent_revenue type: metric - - id: campaign_spend type: visualizationObject @@ -724,11 +724,11 @@ interactions: type: analyticalDashboard - - id: campaign_name_filter type: filterContext - - id: campaign + - id: dashboard_plugin type: analyticalDashboard - - id: campaign_name_filter type: filterContext - - id: dashboard_plugin + - id: campaign type: analyticalDashboard - - id: region_filter type: filterContext diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_load_and_modify_ds_and_put_declarative_ldm.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_load_and_modify_ds_and_put_declarative_ldm.yaml index 28f083fef..840bf3437 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_load_and_modify_ds_and_put_declarative_ldm.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_load_and_modify_ds_and_put_declarative_ldm.yaml @@ -44,7 +44,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: 1a3fc86182f182e1bbc97bf0ca49dd47 + traceId: 7d04128a3835a8e7055eb800e8cd74f3 - request: method: POST uri: http://localhost:3000/api/v1/entities/workspaces @@ -556,8 +556,8 @@ interactions: username: postgres authenticationType: USERNAME_PASSWORD alternativeDataSourceId: ds-put-abc-id - name: demo-test-ds type: POSTGRESQL + name: demo-test-ds schema: demo id: demo-test-ds links: @@ -1011,8 +1011,8 @@ interactions: username: postgres authenticationType: USERNAME_PASSWORD alternativeDataSourceId: ds-put-abc-id - name: demo-test-ds type: POSTGRESQL + name: demo-test-ds schema: demo id: demo-test-ds links: diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_load_and_put_declarative_analytics_model.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_load_and_put_declarative_analytics_model.yaml index 7c5e853ea..ae3bcce88 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_load_and_put_declarative_analytics_model.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_load_and_put_declarative_analytics_model.yaml @@ -44,7 +44,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: c239dd6ec8e7f5860f257ce943d93c6b + traceId: 095c31035d754b778112a8549f5b12f9 - request: method: POST uri: http://localhost:3000/api/v1/entities/workspaces diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_load_and_put_declarative_ldm.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_load_and_put_declarative_ldm.yaml index 83b655e3e..963319bdd 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_load_and_put_declarative_ldm.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_load_and_put_declarative_ldm.yaml @@ -44,7 +44,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: 6c8d85a687d51ff51b74422ef1299198 + traceId: d414f285c8a48d6dd4ed27f2f53af9a8 - request: method: POST uri: http://localhost:3000/api/v1/entities/workspaces diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_put_declarative_analytics_model.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_put_declarative_analytics_model.yaml index 1ce891305..932f60d75 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_put_declarative_analytics_model.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_put_declarative_analytics_model.yaml @@ -33,7 +33,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: bdab3ee9793e4510c6198a2db211b552 + traceId: 4eefe5a919034e1097a92627da4d4806 - request: method: POST uri: http://localhost:3000/api/v1/entities/workspaces diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_put_declarative_ldm.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_put_declarative_ldm.yaml index 2cbbd9955..680b74434 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_put_declarative_ldm.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_put_declarative_ldm.yaml @@ -33,7 +33,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: 3dc127a2db60e50ffb4e361d685e93a0 + traceId: 5b98e619b3cf40b79ecda5ee7877362e - request: method: POST uri: http://localhost:3000/api/v1/entities/workspaces diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_store_declarative_analytics_model.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_store_declarative_analytics_model.yaml index 9012c50f3..1f4ff5d38 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_store_declarative_analytics_model.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_store_declarative_analytics_model.yaml @@ -94,7 +94,7 @@ interactions: drills: [] properties: {} version: '2' - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -137,7 +137,7 @@ interactions: type: dashboardPlugin version: '2' version: '2' - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -287,7 +287,7 @@ interactions: drills: [] properties: {} version: '2' - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -299,7 +299,7 @@ interactions: - content: url: https://www.example.com version: '2' - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -309,7 +309,7 @@ interactions: - content: url: https://www.example.com version: '2' - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -360,7 +360,7 @@ interactions: - content: format: '#,##0' maql: SELECT COUNT({attribute/customer_id},{attribute/order_line_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -369,7 +369,7 @@ interactions: - content: format: '#,##0' maql: SELECT COUNT({attribute/order_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -379,7 +379,7 @@ interactions: format: '#,##0' maql: 'SELECT {metric/amount_of_active_customers} WHERE (SELECT {metric/revenue} BY {attribute/customer_id}) > 10000 ' - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -389,7 +389,7 @@ interactions: format: '#,##0.00' maql: SELECT {metric/amount_of_orders} WHERE NOT ({label/order_status} IN ("Returned", "Canceled")) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -399,7 +399,7 @@ interactions: - content: format: $#,##0 maql: SELECT SUM({fact/spend}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -408,7 +408,7 @@ interactions: - content: format: $#,##0 maql: SELECT SUM({fact/price}*{fact/quantity}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -417,7 +417,7 @@ interactions: - content: format: '#,##0.0%' maql: SELECT {metric/revenue} / {metric/total_revenue} - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -427,7 +427,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10}\ \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -437,7 +437,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10_percent}\ \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -447,7 +447,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10_percent}\ \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -457,7 +457,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10}\ \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -467,7 +467,7 @@ interactions: format: '#,##0.0%' maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY {attribute/products.category}, ALL OTHER) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -477,7 +477,7 @@ interactions: format: '#,##0.0%' maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY ALL {attribute/product_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -487,7 +487,7 @@ interactions: format: $#,##0 maql: SELECT {metric/order_amount} WHERE NOT ({label/order_status} IN ("Returned", "Canceled")) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -498,7 +498,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Clothing") - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -508,7 +508,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ( "Electronics") - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -518,7 +518,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Home") - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -528,7 +528,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Outdoor") - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -537,7 +537,7 @@ interactions: - content: format: $#,##0.0 maql: SELECT AVG(SELECT {metric/revenue} BY {attribute/customer_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -546,7 +546,7 @@ interactions: - content: format: $#,##0.0 maql: SELECT {metric/revenue} / {metric/campaign_spend} - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -555,7 +555,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} WHERE TOP(10) OF ({metric/revenue}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -564,7 +564,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} WHERE TOP(10%) OF ({metric/revenue}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -573,7 +573,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} BY ALL OTHER - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -582,7 +582,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/total_revenue} WITHOUT PARENT FILTER - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -647,7 +647,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:treemap - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -723,7 +723,7 @@ interactions: rotation: auto version: '2' visualizationUrl: local:combo2 - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -802,7 +802,7 @@ interactions: direction: asc version: '2' visualizationUrl: local:table - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -861,7 +861,7 @@ interactions: stackMeasuresToPercent: true version: '2' visualizationUrl: local:area - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -918,7 +918,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:treemap - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -971,7 +971,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:donut - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1046,7 +1046,7 @@ interactions: visible: false version: '2' visualizationUrl: local:column - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1103,7 +1103,7 @@ interactions: enabled: true version: '2' visualizationUrl: local:scatter - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1202,7 +1202,7 @@ interactions: direction: asc version: '2' visualizationUrl: local:table - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1258,7 +1258,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:line - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1297,7 +1297,7 @@ interactions: properties: {} version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1353,7 +1353,7 @@ interactions: min: '0' version: '2' visualizationUrl: local:scatter - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1421,7 +1421,7 @@ interactions: rotation: auto version: '2' visualizationUrl: local:combo2 - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1478,7 +1478,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1535,7 +1535,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1734,7 +1734,7 @@ interactions: drills: [] properties: {} version: '2' - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1777,7 +1777,7 @@ interactions: type: dashboardPlugin version: '2' version: '2' - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1927,7 +1927,7 @@ interactions: drills: [] properties: {} version: '2' - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1939,7 +1939,7 @@ interactions: - content: url: https://www.example.com version: '2' - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1949,7 +1949,7 @@ interactions: - content: url: https://www.example.com version: '2' - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2000,7 +2000,7 @@ interactions: - content: format: '#,##0' maql: SELECT COUNT({attribute/customer_id},{attribute/order_line_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2009,7 +2009,7 @@ interactions: - content: format: '#,##0' maql: SELECT COUNT({attribute/order_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2019,7 +2019,7 @@ interactions: format: '#,##0' maql: 'SELECT {metric/amount_of_active_customers} WHERE (SELECT {metric/revenue} BY {attribute/customer_id}) > 10000 ' - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2029,7 +2029,7 @@ interactions: format: '#,##0.00' maql: SELECT {metric/amount_of_orders} WHERE NOT ({label/order_status} IN ("Returned", "Canceled")) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2039,7 +2039,7 @@ interactions: - content: format: $#,##0 maql: SELECT SUM({fact/spend}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2048,7 +2048,7 @@ interactions: - content: format: $#,##0 maql: SELECT SUM({fact/price}*{fact/quantity}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2057,7 +2057,7 @@ interactions: - content: format: '#,##0.0%' maql: SELECT {metric/revenue} / {metric/total_revenue} - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2067,7 +2067,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10}\ \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2077,7 +2077,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10_percent}\ \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2087,7 +2087,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10_percent}\ \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2097,7 +2097,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10}\ \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2107,7 +2107,7 @@ interactions: format: '#,##0.0%' maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY {attribute/products.category}, ALL OTHER) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2117,7 +2117,7 @@ interactions: format: '#,##0.0%' maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY ALL {attribute/product_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2127,7 +2127,7 @@ interactions: format: $#,##0 maql: SELECT {metric/order_amount} WHERE NOT ({label/order_status} IN ("Returned", "Canceled")) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2138,7 +2138,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Clothing") - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2148,7 +2148,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ( "Electronics") - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2158,7 +2158,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Home") - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2168,7 +2168,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Outdoor") - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2177,7 +2177,7 @@ interactions: - content: format: $#,##0.0 maql: SELECT AVG(SELECT {metric/revenue} BY {attribute/customer_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2186,7 +2186,7 @@ interactions: - content: format: $#,##0.0 maql: SELECT {metric/revenue} / {metric/campaign_spend} - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2195,7 +2195,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} WHERE TOP(10) OF ({metric/revenue}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2204,7 +2204,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} WHERE TOP(10%) OF ({metric/revenue}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2213,7 +2213,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} BY ALL OTHER - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2222,7 +2222,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/total_revenue} WITHOUT PARENT FILTER - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2287,7 +2287,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:treemap - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2363,7 +2363,7 @@ interactions: rotation: auto version: '2' visualizationUrl: local:combo2 - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2442,7 +2442,7 @@ interactions: direction: asc version: '2' visualizationUrl: local:table - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2501,7 +2501,7 @@ interactions: stackMeasuresToPercent: true version: '2' visualizationUrl: local:area - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2558,7 +2558,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:treemap - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2611,7 +2611,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:donut - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2686,7 +2686,7 @@ interactions: visible: false version: '2' visualizationUrl: local:column - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2743,7 +2743,7 @@ interactions: enabled: true version: '2' visualizationUrl: local:scatter - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2842,7 +2842,7 @@ interactions: direction: asc version: '2' visualizationUrl: local:table - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2898,7 +2898,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:line - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2937,7 +2937,7 @@ interactions: properties: {} version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2993,7 +2993,7 @@ interactions: min: '0' version: '2' visualizationUrl: local:scatter - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3061,7 +3061,7 @@ interactions: rotation: auto version: '2' visualizationUrl: local:combo2 - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3118,7 +3118,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3175,7 +3175,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/explicit_workspace_data_filter.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/explicit_workspace_data_filter.yaml index d4cd84278..f8b4558aa 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/explicit_workspace_data_filter.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/explicit_workspace_data_filter.yaml @@ -1745,10 +1745,10 @@ interactions: type: dataset labels: data: - - id: state - type: label - id: geo__state__location type: label + - id: state + type: label type: attribute - attributes: title: Type @@ -1812,28 +1812,28 @@ interactions: type: attribute referenceProperties: - identifier: - id: campaigns + id: products type: dataset multivalue: false sources: - - column: campaign_id + - column: product_id dataType: INT target: - id: campaign_id + id: product_id type: attribute isNullable: null nullValue: null sourceColumns: null sourceColumnDataTypes: null - identifier: - id: customers + id: campaigns type: dataset multivalue: false sources: - - column: customer_id + - column: campaign_id dataType: INT target: - id: customer_id + id: campaign_id type: attribute isNullable: null nullValue: null @@ -1854,14 +1854,14 @@ interactions: sourceColumns: null sourceColumnDataTypes: null - identifier: - id: products + id: customers type: dataset multivalue: false sources: - - column: product_id + - column: customer_id dataType: INT target: - id: product_id + id: customer_id type: attribute isNullable: null nullValue: null @@ -2472,28 +2472,28 @@ interactions: type: attribute referenceProperties: - identifier: - id: campaigns + id: products type: dataset multivalue: false sources: - - column: campaign_id + - column: product_id dataType: INT target: - id: campaign_id + id: product_id type: attribute isNullable: null nullValue: null sourceColumns: null sourceColumnDataTypes: null - identifier: - id: customers + id: campaigns type: dataset multivalue: false sources: - - column: customer_id + - column: campaign_id dataType: INT target: - id: customer_id + id: campaign_id type: attribute isNullable: null nullValue: null @@ -2514,14 +2514,14 @@ interactions: sourceColumns: null sourceColumnDataTypes: null - identifier: - id: products + id: customers type: dataset multivalue: false sources: - - column: product_id + - column: customer_id dataType: INT target: - id: product_id + id: customer_id type: attribute isNullable: null nullValue: null @@ -2926,7 +2926,7 @@ interactions: content: format: '#,##0' maql: SELECT COUNT({attribute/customer_id},{attribute/order_line_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: amount_of_active_customers links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/amount_of_active_customers @@ -2941,7 +2941,7 @@ interactions: content: format: '#,##0' maql: SELECT COUNT({attribute/order_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: amount_of_orders links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/amount_of_orders @@ -2957,7 +2957,7 @@ interactions: format: '#,##0' maql: 'SELECT {metric/amount_of_active_customers} WHERE (SELECT {metric/revenue} BY {attribute/customer_id}) > 10000 ' - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: amount_of_top_customers links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/amount_of_top_customers @@ -2974,7 +2974,7 @@ interactions: format: '#,##0.00' maql: SELECT {metric/amount_of_orders} WHERE NOT ({label/order_status} IN ("Returned", "Canceled")) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: amount_of_valid_orders links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/amount_of_valid_orders @@ -2989,7 +2989,7 @@ interactions: content: format: $#,##0 maql: SELECT SUM({fact/spend}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: campaign_spend links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/campaign_spend @@ -3004,7 +3004,7 @@ interactions: content: format: $#,##0 maql: SELECT SUM({fact/price}*{fact/quantity}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: order_amount links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/order_amount @@ -3019,7 +3019,7 @@ interactions: content: format: '#,##0.0%' maql: SELECT {metric/revenue} / {metric/total_revenue} - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: percent_revenue links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/percent_revenue @@ -3035,7 +3035,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10}\ \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: percent_revenue_from_top_10_customers links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/percent_revenue_from_top_10_customers @@ -3051,7 +3051,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10_percent}\ \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: percent_revenue_from_top_10_percent_customers links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/percent_revenue_from_top_10_percent_customers @@ -3067,7 +3067,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10_percent}\ \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: percent_revenue_from_top_10_percent_products links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/percent_revenue_from_top_10_percent_products @@ -3083,7 +3083,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10}\ \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: percent_revenue_from_top_10_products links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/percent_revenue_from_top_10_products @@ -3099,7 +3099,7 @@ interactions: format: '#,##0.0%' maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY {attribute/products.category}, ALL OTHER) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: percent_revenue_in_category links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/percent_revenue_in_category @@ -3115,7 +3115,7 @@ interactions: format: '#,##0.0%' maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY ALL {attribute/product_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: percent_revenue_per_product links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/percent_revenue_per_product @@ -3132,7 +3132,7 @@ interactions: format: $#,##0 maql: SELECT {metric/order_amount} WHERE NOT ({label/order_status} IN ("Returned", "Canceled")) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue @@ -3148,7 +3148,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Clothing") - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue-clothing links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue-clothing @@ -3164,7 +3164,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ( "Electronics") - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue-electronic links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue-electronic @@ -3180,7 +3180,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Home") - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue-home links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue-home @@ -3196,7 +3196,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Outdoor") - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue-outdoor links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue-outdoor @@ -3211,7 +3211,7 @@ interactions: content: format: $#,##0.0 maql: SELECT AVG(SELECT {metric/revenue} BY {attribute/customer_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue_per_customer links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue_per_customer @@ -3226,7 +3226,7 @@ interactions: content: format: $#,##0.0 maql: SELECT {metric/revenue} / {metric/campaign_spend} - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue_per_dollar_spent links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue_per_dollar_spent @@ -3241,7 +3241,7 @@ interactions: content: format: $#,##0 maql: SELECT {metric/revenue} WHERE TOP(10) OF ({metric/revenue}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue_top_10 links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue_top_10 @@ -3256,7 +3256,7 @@ interactions: content: format: $#,##0 maql: SELECT {metric/revenue} WHERE TOP(10%) OF ({metric/revenue}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue_top_10_percent links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue_top_10_percent @@ -3271,7 +3271,7 @@ interactions: content: format: $#,##0 maql: SELECT {metric/revenue} BY ALL OTHER - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: total_revenue links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/total_revenue @@ -3286,7 +3286,7 @@ interactions: content: format: $#,##0 maql: SELECT {metric/total_revenue} WITHOUT PARENT FILTER - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: total_revenue-no_filters links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/total_revenue-no_filters diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/label_elements.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/label_elements.yaml index f9f9fe590..c275eb9ad 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/label_elements.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/label_elements.yaml @@ -67,7 +67,7 @@ interactions: count: 2 offset: 0 next: null - cacheId: 1dad6f60655b6e8ed90db446defdfdfe + cacheId: ca9069c24768892cf9051f090d7b3dc1 - request: method: POST uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/collectLabelElements @@ -128,7 +128,7 @@ interactions: count: 1 offset: 0 next: null - cacheId: bafa33d82fab7060287982679d17d5bf + cacheId: 39c00fd5bc4982e3d49afd9280ae6099 - request: method: POST uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/collectLabelElements @@ -191,7 +191,7 @@ interactions: count: 3 offset: 0 next: null - cacheId: 81bfdcf9a5da23f78d46a299771f7d51 + cacheId: cbc5e77a19e54bf6d63567995d3af82b - request: method: POST uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/collectLabelElements @@ -256,7 +256,7 @@ interactions: count: 0 offset: 0 next: null - cacheId: 57924fb42336f0eecf1ca7d2630117c8 + cacheId: 5995a06a1408e29ddad02d38391eff46 - request: method: POST uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/collectLabelElements @@ -322,7 +322,7 @@ interactions: count: 0 offset: 0 next: null - cacheId: fa569c0befb98722f21741bd19969b4d + cacheId: 45794894c8658f26b9436f3d2f2dd480 - request: method: POST uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/collectLabelElements @@ -388,7 +388,7 @@ interactions: count: 2 offset: 0 next: null - cacheId: 1dad6f60655b6e8ed90db446defdfdfe + cacheId: ca9069c24768892cf9051f090d7b3dc1 - request: method: POST uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/collectLabelElements @@ -448,7 +448,7 @@ interactions: count: 1 offset: 0 next: null - cacheId: 733985df796c88c967262e92a4194e2a + cacheId: 1cea05d2dea3be8ddd6fa888354d46be - request: method: POST uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/collectLabelElements @@ -511,7 +511,7 @@ interactions: count: 2 offset: 0 next: null - cacheId: 6c31098fd5213241b32f97b27adb3ac1 + cacheId: c9081fa6226c5e7338ae8262488e9a13 - request: method: POST uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/collectLabelElements @@ -575,7 +575,7 @@ interactions: count: 3 offset: 0 next: null - cacheId: 45bbcb1d3ab366ee1fcbb97b80359f5d + cacheId: d04ff821bf2a3946e6edd9f8865ff706 - request: method: POST uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/collectLabelElements?offset=1&limit=1 @@ -634,4 +634,4 @@ interactions: count: 1 offset: 1 next: http://localhost:3000/api/v1/actions/workspaces/demo/execution/collectLabelElements?limit=1&offset=2 - cacheId: 81bfdcf9a5da23f78d46a299771f7d51 + cacheId: cbc5e77a19e54bf6d63567995d3af82b diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/create_workspace_setting.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/create_workspace_setting.yaml index f13dddfe8..271a16999 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/create_workspace_setting.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/create_workspace_setting.yaml @@ -48,7 +48,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: 589dc15ab76a0c298609a73f3de5bfe9 + traceId: ab74dbb6190e5ff8e94a18f8451628bc - request: method: POST uri: http://localhost:3000/api/v1/entities/workspaces/demo/workspaceSettings @@ -206,49 +206,3 @@ interactions: - '0' body: string: '' - - request: - method: GET - uri: http://localhost:3000/api/v1/entities/workspaces/demo/workspaceSettings?page=0&size=500 - body: null - headers: - Accept: - - application/json - Accept-Encoding: - - br, gzip, deflate - X-GDC-VALIDATE-RELATIONS: - - 'true' - X-Requested-With: - - XMLHttpRequest - response: - status: - code: 200 - message: OK - headers: - Cache-Control: - - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '215' - Content-Type: - - application/json - DATE: *id001 - Expires: - - '0' - Pragma: - - no-cache - Referrer-Policy: - - no-referrer - Vary: - - Origin - - Access-Control-Request-Method - - Access-Control-Request-Headers - X-Content-Type-Options: - - nosniff - X-GDC-TRACE-ID: *id001 - X-Xss-Protection: - - '0' - body: - string: - data: [] - links: - self: http://localhost:3000/api/v1/entities/workspaces/demo/workspaceSettings?page=0&size=500 - next: http://localhost:3000/api/v1/entities/workspaces/demo/workspaceSettings?page=1&size=500 diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/delete_workspace_setting.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/delete_workspace_setting.yaml index 8ba5c5a25..1c5c7a526 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/delete_workspace_setting.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/delete_workspace_setting.yaml @@ -48,7 +48,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: 095b653dda926b5baacd5cec035176ae + traceId: 14c872e0d2adbf9d24a8379d297a5142 - request: method: POST uri: http://localhost:3000/api/v1/entities/workspaces/demo/workspaceSettings @@ -290,49 +290,3 @@ interactions: - '0' body: string: '' - - request: - method: GET - uri: http://localhost:3000/api/v1/entities/workspaces/demo/workspaceSettings?page=0&size=500 - body: null - headers: - Accept: - - application/json - Accept-Encoding: - - br, gzip, deflate - X-GDC-VALIDATE-RELATIONS: - - 'true' - X-Requested-With: - - XMLHttpRequest - response: - status: - code: 200 - message: OK - headers: - Cache-Control: - - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '215' - Content-Type: - - application/json - DATE: *id001 - Expires: - - '0' - Pragma: - - no-cache - Referrer-Policy: - - no-referrer - Vary: - - Origin - - Access-Control-Request-Method - - Access-Control-Request-Headers - X-Content-Type-Options: - - nosniff - X-GDC-TRACE-ID: *id001 - X-Xss-Protection: - - '0' - body: - string: - data: [] - links: - self: http://localhost:3000/api/v1/entities/workspaces/demo/workspaceSettings?page=0&size=500 - next: http://localhost:3000/api/v1/entities/workspaces/demo/workspaceSettings?page=1&size=500 diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/demo_clone_workspace.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/demo_clone_workspace.yaml index a53bdb731..f64ffab66 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/demo_clone_workspace.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/demo_clone_workspace.yaml @@ -48,7 +48,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: 456870835e975653c6cd83ad50ee3926 + traceId: 7a6e813f043c01d294671a06523f666d - request: method: POST uri: http://localhost:3000/api/v1/entities/dataSources @@ -108,8 +108,8 @@ interactions: url: jdbc:postgresql://localhost:5432/demo?autosave=false&sslmode=prefer username: demouser authenticationType: USERNAME_PASSWORD - name: Test2 type: POSTGRESQL + name: Test2 schema: demo id: demo-bigquery-ds type: dataSource @@ -207,7 +207,7 @@ interactions: drills: [] properties: {} version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -250,7 +250,7 @@ interactions: type: dashboardPlugin version: '2' version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -400,7 +400,7 @@ interactions: drills: [] properties: {} version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -412,7 +412,7 @@ interactions: - content: url: https://www.example.com version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -422,7 +422,7 @@ interactions: - content: url: https://www.example.com version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -473,7 +473,7 @@ interactions: - content: format: '#,##0' maql: SELECT COUNT({attribute/customer_id},{attribute/order_line_id}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -482,7 +482,7 @@ interactions: - content: format: '#,##0' maql: SELECT COUNT({attribute/order_id}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -492,7 +492,7 @@ interactions: format: '#,##0' maql: 'SELECT {metric/amount_of_active_customers} WHERE (SELECT {metric/revenue} BY {attribute/customer_id}) > 10000 ' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -502,7 +502,7 @@ interactions: format: '#,##0.00' maql: SELECT {metric/amount_of_orders} WHERE NOT ({label/order_status} IN ("Returned", "Canceled")) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -512,7 +512,7 @@ interactions: - content: format: $#,##0 maql: SELECT SUM({fact/spend}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -521,7 +521,7 @@ interactions: - content: format: $#,##0 maql: SELECT SUM({fact/price}*{fact/quantity}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -530,7 +530,7 @@ interactions: - content: format: '#,##0.0%' maql: SELECT {metric/revenue} / {metric/total_revenue} - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -540,7 +540,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10}\ \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -550,7 +550,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10_percent}\ \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -560,7 +560,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10_percent}\ \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -570,7 +570,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10}\ \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -580,7 +580,7 @@ interactions: format: '#,##0.0%' maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY {attribute/products.category}, ALL OTHER) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -590,7 +590,7 @@ interactions: format: '#,##0.0%' maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY ALL {attribute/product_id}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -600,7 +600,7 @@ interactions: format: $#,##0 maql: SELECT {metric/order_amount} WHERE NOT ({label/order_status} IN ("Returned", "Canceled")) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -611,7 +611,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Clothing") - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -621,7 +621,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ( "Electronics") - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -631,7 +631,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Home") - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -641,7 +641,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Outdoor") - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -650,7 +650,7 @@ interactions: - content: format: $#,##0.0 maql: SELECT AVG(SELECT {metric/revenue} BY {attribute/customer_id}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -659,7 +659,7 @@ interactions: - content: format: $#,##0.0 maql: SELECT {metric/revenue} / {metric/campaign_spend} - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -668,7 +668,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} WHERE TOP(10) OF ({metric/revenue}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -677,7 +677,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} WHERE TOP(10%) OF ({metric/revenue}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -686,7 +686,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} BY ALL OTHER - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -695,7 +695,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/total_revenue} WITHOUT PARENT FILTER - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -760,7 +760,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:treemap - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -836,7 +836,7 @@ interactions: rotation: auto version: '2' visualizationUrl: local:combo2 - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -915,7 +915,7 @@ interactions: direction: asc version: '2' visualizationUrl: local:table - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -974,7 +974,7 @@ interactions: stackMeasuresToPercent: true version: '2' visualizationUrl: local:area - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1031,7 +1031,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:treemap - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1084,7 +1084,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:donut - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1159,7 +1159,7 @@ interactions: visible: false version: '2' visualizationUrl: local:column - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1216,7 +1216,7 @@ interactions: enabled: true version: '2' visualizationUrl: local:scatter - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1315,7 +1315,7 @@ interactions: direction: asc version: '2' visualizationUrl: local:table - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1371,7 +1371,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:line - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1410,7 +1410,7 @@ interactions: properties: {} version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1466,7 +1466,7 @@ interactions: min: '0' version: '2' visualizationUrl: local:scatter - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1534,7 +1534,7 @@ interactions: rotation: auto version: '2' visualizationUrl: local:combo2 - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1591,7 +1591,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1648,7 +1648,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2095,7 +2095,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: 8ce53a61add949f01847ef79fe764cfc + traceId: 1ba081c9e61d16f5073521ac7f4544c7 - request: method: GET uri: http://localhost:3000/api/v1/entities/workspaces/demo_clone?include=workspaces @@ -2127,7 +2127,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: da6864f53a4b7dc6ecce6af5ced5a374 + traceId: 4c3ab93ba06db8b2badc2588194edb0f - request: method: POST uri: http://localhost:3000/api/v1/entities/workspaces @@ -2749,7 +2749,7 @@ interactions: version: '2' id: campaign title: Campaign - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2792,7 +2792,7 @@ interactions: version: '2' id: dashboard_plugin title: Dashboard plugin - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2942,7 +2942,7 @@ interactions: version: '2' id: product_and_category title: Product & Category - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2955,7 +2955,7 @@ interactions: version: '2' id: dashboard_plugin_1 title: dashboard_plugin_1 - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2965,7 +2965,7 @@ interactions: version: '2' id: dashboard_plugin_2 title: dashboard_plugin_2 - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3014,7 +3014,7 @@ interactions: maql: SELECT COUNT({attribute/customer_id},{attribute/order_line_id}) id: amount_of_active_customers title: '# of Active Customers' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3023,7 +3023,7 @@ interactions: maql: SELECT COUNT({attribute/order_id}) id: amount_of_orders title: '# of Orders' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3033,7 +3033,7 @@ interactions: BY {attribute/customer_id}) > 10000 ' id: amount_of_top_customers title: '# of Top Customers' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3043,7 +3043,7 @@ interactions: IN ("Returned", "Canceled")) id: amount_of_valid_orders title: '# of Valid Orders' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3053,7 +3053,7 @@ interactions: maql: SELECT SUM({fact/spend}) id: campaign_spend title: Campaign Spend - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3062,7 +3062,7 @@ interactions: maql: SELECT SUM({fact/price}*{fact/quantity}) id: order_amount title: Order Amount - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3071,7 +3071,7 @@ interactions: maql: SELECT {metric/revenue} / {metric/total_revenue} id: percent_revenue title: '% Revenue' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3081,7 +3081,7 @@ interactions: \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" id: percent_revenue_from_top_10_customers title: '% Revenue from Top 10 Customers' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3091,7 +3091,7 @@ interactions: \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" id: percent_revenue_from_top_10_percent_customers title: '% Revenue from Top 10% Customers' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3101,7 +3101,7 @@ interactions: \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" id: percent_revenue_from_top_10_percent_products title: '% Revenue from Top 10% Products' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3111,7 +3111,7 @@ interactions: \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" id: percent_revenue_from_top_10_products title: '% Revenue from Top 10 Products' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3121,7 +3121,7 @@ interactions: ALL OTHER) id: percent_revenue_in_category title: '% Revenue in Category' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3130,7 +3130,7 @@ interactions: maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY ALL {attribute/product_id}) id: percent_revenue_per_product title: '% Revenue per Product' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3140,7 +3140,7 @@ interactions: IN ("Returned", "Canceled")) id: revenue title: Revenue - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3150,7 +3150,7 @@ interactions: maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Clothing") id: revenue-clothing title: Revenue (Clothing) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3160,7 +3160,7 @@ interactions: "Electronics") id: revenue-electronic title: Revenue (Electronic) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3169,7 +3169,7 @@ interactions: maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Home") id: revenue-home title: Revenue (Home) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3178,7 +3178,7 @@ interactions: maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Outdoor") id: revenue-outdoor title: Revenue (Outdoor) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3187,7 +3187,7 @@ interactions: maql: SELECT AVG(SELECT {metric/revenue} BY {attribute/customer_id}) id: revenue_per_customer title: Revenue per Customer - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3196,7 +3196,7 @@ interactions: maql: SELECT {metric/revenue} / {metric/campaign_spend} id: revenue_per_dollar_spent title: Revenue per Dollar Spent - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3205,7 +3205,7 @@ interactions: maql: SELECT {metric/revenue} WHERE TOP(10) OF ({metric/revenue}) id: revenue_top_10 title: Revenue / Top 10 - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3214,7 +3214,7 @@ interactions: maql: SELECT {metric/revenue} WHERE TOP(10%) OF ({metric/revenue}) id: revenue_top_10_percent title: Revenue / Top 10% - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3223,7 +3223,7 @@ interactions: maql: SELECT {metric/revenue} BY ALL OTHER id: total_revenue title: Total Revenue - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3232,7 +3232,7 @@ interactions: maql: SELECT {metric/total_revenue} WITHOUT PARENT FILTER id: total_revenue-no_filters title: Total Revenue (No Filters) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3297,7 +3297,7 @@ interactions: visualizationUrl: local:treemap id: campaign_spend title: Campaign Spend - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3373,7 +3373,7 @@ interactions: visualizationUrl: local:combo2 id: customers_trend title: Customers Trend - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3452,7 +3452,7 @@ interactions: visualizationUrl: local:table id: percent_revenue_per_product_by_customer_and_category title: '% Revenue per Product by Customer and Category' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3511,7 +3511,7 @@ interactions: visualizationUrl: local:area id: percentage_of_customers_by_region title: Percentage of Customers by Region - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3568,7 +3568,7 @@ interactions: visualizationUrl: local:treemap id: product_breakdown title: Product Breakdown - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3621,7 +3621,7 @@ interactions: visualizationUrl: local:donut id: product_categories_pie_chart title: Product Categories Pie Chart - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3696,7 +3696,7 @@ interactions: visualizationUrl: local:column id: product_revenue_comparison-over_previous_period title: Product Revenue Comparison (over previous period) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3753,7 +3753,7 @@ interactions: visualizationUrl: local:scatter id: product_saleability title: Product Saleability - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3852,7 +3852,7 @@ interactions: visualizationUrl: local:table id: revenue_and_quantity_by_product_and_category title: Revenue and Quantity by Product and Category - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3908,7 +3908,7 @@ interactions: visualizationUrl: local:line id: revenue_by_category_trend title: Revenue by Category Trend - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3947,7 +3947,7 @@ interactions: visualizationUrl: local:bar id: revenue_by_product title: Revenue by Product - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4003,7 +4003,7 @@ interactions: visualizationUrl: local:scatter id: revenue_per_usd_vs_spend_by_campaign title: Revenue per $ vs Spend by Campaign - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4071,7 +4071,7 @@ interactions: visualizationUrl: local:combo2 id: revenue_trend title: Revenue Trend - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4128,7 +4128,7 @@ interactions: visualizationUrl: local:bar id: top_10_customers title: Top 10 Customers - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4185,7 +4185,7 @@ interactions: visualizationUrl: local:bar id: top_10_products title: Top 10 Products - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4478,7 +4478,7 @@ interactions: drills: [] properties: {} version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4521,7 +4521,7 @@ interactions: type: dashboardPlugin version: '2' version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4671,7 +4671,7 @@ interactions: drills: [] properties: {} version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4683,7 +4683,7 @@ interactions: - content: url: https://www.example.com version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4693,7 +4693,7 @@ interactions: - content: url: https://www.example.com version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4744,7 +4744,7 @@ interactions: - content: format: '#,##0' maql: SELECT COUNT({attribute/customer_id},{attribute/order_line_id}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4753,7 +4753,7 @@ interactions: - content: format: '#,##0' maql: SELECT COUNT({attribute/order_id}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4763,7 +4763,7 @@ interactions: format: '#,##0' maql: 'SELECT {metric/amount_of_active_customers} WHERE (SELECT {metric/revenue} BY {attribute/customer_id}) > 10000 ' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4773,7 +4773,7 @@ interactions: format: '#,##0.00' maql: SELECT {metric/amount_of_orders} WHERE NOT ({label/order_status} IN ("Returned", "Canceled")) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4783,7 +4783,7 @@ interactions: - content: format: $#,##0 maql: SELECT SUM({fact/spend}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4792,7 +4792,7 @@ interactions: - content: format: $#,##0 maql: SELECT SUM({fact/price}*{fact/quantity}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4801,7 +4801,7 @@ interactions: - content: format: '#,##0.0%' maql: SELECT {metric/revenue} / {metric/total_revenue} - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4811,7 +4811,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10}\ \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4821,7 +4821,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10_percent}\ \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4831,7 +4831,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10_percent}\ \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4841,7 +4841,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10}\ \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4851,7 +4851,7 @@ interactions: format: '#,##0.0%' maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY {attribute/products.category}, ALL OTHER) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4861,7 +4861,7 @@ interactions: format: '#,##0.0%' maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY ALL {attribute/product_id}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4871,7 +4871,7 @@ interactions: format: $#,##0 maql: SELECT {metric/order_amount} WHERE NOT ({label/order_status} IN ("Returned", "Canceled")) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4882,7 +4882,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Clothing") - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4892,7 +4892,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ( "Electronics") - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4902,7 +4902,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Home") - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4912,7 +4912,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Outdoor") - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4921,7 +4921,7 @@ interactions: - content: format: $#,##0.0 maql: SELECT AVG(SELECT {metric/revenue} BY {attribute/customer_id}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4930,7 +4930,7 @@ interactions: - content: format: $#,##0.0 maql: SELECT {metric/revenue} / {metric/campaign_spend} - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4939,7 +4939,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} WHERE TOP(10) OF ({metric/revenue}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4948,7 +4948,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} WHERE TOP(10%) OF ({metric/revenue}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4957,7 +4957,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} BY ALL OTHER - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4966,7 +4966,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/total_revenue} WITHOUT PARENT FILTER - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5031,7 +5031,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:treemap - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5107,7 +5107,7 @@ interactions: rotation: auto version: '2' visualizationUrl: local:combo2 - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5186,7 +5186,7 @@ interactions: direction: asc version: '2' visualizationUrl: local:table - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5245,7 +5245,7 @@ interactions: stackMeasuresToPercent: true version: '2' visualizationUrl: local:area - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5302,7 +5302,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:treemap - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5355,7 +5355,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:donut - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5430,7 +5430,7 @@ interactions: visible: false version: '2' visualizationUrl: local:column - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5487,7 +5487,7 @@ interactions: enabled: true version: '2' visualizationUrl: local:scatter - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5586,7 +5586,7 @@ interactions: direction: asc version: '2' visualizationUrl: local:table - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5642,7 +5642,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:line - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5681,7 +5681,7 @@ interactions: properties: {} version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5737,7 +5737,7 @@ interactions: min: '0' version: '2' visualizationUrl: local:scatter - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5805,7 +5805,7 @@ interactions: rotation: auto version: '2' visualizationUrl: local:combo2 - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5862,7 +5862,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5919,7 +5919,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -6382,7 +6382,7 @@ interactions: drills: [] properties: {} version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -6425,7 +6425,7 @@ interactions: type: dashboardPlugin version: '2' version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -6575,7 +6575,7 @@ interactions: drills: [] properties: {} version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -6587,7 +6587,7 @@ interactions: - content: url: https://www.example.com version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -6597,7 +6597,7 @@ interactions: - content: url: https://www.example.com version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -6648,7 +6648,7 @@ interactions: - content: format: '#,##0' maql: SELECT COUNT({attribute/customer_id},{attribute/order_line_id}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -6657,7 +6657,7 @@ interactions: - content: format: '#,##0' maql: SELECT COUNT({attribute/order_id}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -6667,7 +6667,7 @@ interactions: format: '#,##0' maql: 'SELECT {metric/amount_of_active_customers} WHERE (SELECT {metric/revenue} BY {attribute/customer_id}) > 10000 ' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -6677,7 +6677,7 @@ interactions: format: '#,##0.00' maql: SELECT {metric/amount_of_orders} WHERE NOT ({label/order_status} IN ("Returned", "Canceled")) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -6687,7 +6687,7 @@ interactions: - content: format: $#,##0 maql: SELECT SUM({fact/spend}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -6696,7 +6696,7 @@ interactions: - content: format: $#,##0 maql: SELECT SUM({fact/price}*{fact/quantity}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -6705,7 +6705,7 @@ interactions: - content: format: '#,##0.0%' maql: SELECT {metric/revenue} / {metric/total_revenue} - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -6715,7 +6715,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10}\ \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -6725,7 +6725,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10_percent}\ \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -6735,7 +6735,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10_percent}\ \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -6745,7 +6745,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10}\ \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -6755,7 +6755,7 @@ interactions: format: '#,##0.0%' maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY {attribute/products.category}, ALL OTHER) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -6765,7 +6765,7 @@ interactions: format: '#,##0.0%' maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY ALL {attribute/product_id}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -6775,7 +6775,7 @@ interactions: format: $#,##0 maql: SELECT {metric/order_amount} WHERE NOT ({label/order_status} IN ("Returned", "Canceled")) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -6786,7 +6786,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Clothing") - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -6796,7 +6796,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ( "Electronics") - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -6806,7 +6806,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Home") - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -6816,7 +6816,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Outdoor") - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -6825,7 +6825,7 @@ interactions: - content: format: $#,##0.0 maql: SELECT AVG(SELECT {metric/revenue} BY {attribute/customer_id}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -6834,7 +6834,7 @@ interactions: - content: format: $#,##0.0 maql: SELECT {metric/revenue} / {metric/campaign_spend} - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -6843,7 +6843,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} WHERE TOP(10) OF ({metric/revenue}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -6852,7 +6852,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} WHERE TOP(10%) OF ({metric/revenue}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -6861,7 +6861,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} BY ALL OTHER - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -6870,7 +6870,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/total_revenue} WITHOUT PARENT FILTER - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -6935,7 +6935,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:treemap - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -7011,7 +7011,7 @@ interactions: rotation: auto version: '2' visualizationUrl: local:combo2 - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -7090,7 +7090,7 @@ interactions: direction: asc version: '2' visualizationUrl: local:table - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -7149,7 +7149,7 @@ interactions: stackMeasuresToPercent: true version: '2' visualizationUrl: local:area - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -7206,7 +7206,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:treemap - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -7259,7 +7259,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:donut - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -7334,7 +7334,7 @@ interactions: visible: false version: '2' visualizationUrl: local:column - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -7391,7 +7391,7 @@ interactions: enabled: true version: '2' visualizationUrl: local:scatter - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -7490,7 +7490,7 @@ interactions: direction: asc version: '2' visualizationUrl: local:table - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -7546,7 +7546,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:line - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -7585,7 +7585,7 @@ interactions: properties: {} version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -7641,7 +7641,7 @@ interactions: min: '0' version: '2' visualizationUrl: local:scatter - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -7709,7 +7709,7 @@ interactions: rotation: auto version: '2' visualizationUrl: local:combo2 - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -7766,7 +7766,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -7823,7 +7823,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -8270,7 +8270,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: b9d99d2ee7d3ee19bc3d96785fb77b64 + traceId: dae9deae4e0b962a8878594136db0532 - request: method: GET uri: http://localhost:3000/api/v1/entities/workspaces/demo_jacek?include=workspaces @@ -8302,7 +8302,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: 08b73d479c6182dacf16bfebdbfecdc2 + traceId: d1321563319a81c68a9ca128889cade1 - request: method: POST uri: http://localhost:3000/api/v1/entities/workspaces @@ -8938,7 +8938,7 @@ interactions: version: '2' id: campaign title: Campaign - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -8981,7 +8981,7 @@ interactions: version: '2' id: dashboard_plugin title: Dashboard plugin - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -9131,7 +9131,7 @@ interactions: version: '2' id: product_and_category title: Product & Category - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -9144,7 +9144,7 @@ interactions: version: '2' id: dashboard_plugin_1 title: dashboard_plugin_1 - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -9154,7 +9154,7 @@ interactions: version: '2' id: dashboard_plugin_2 title: dashboard_plugin_2 - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -9203,7 +9203,7 @@ interactions: maql: SELECT COUNT({attribute/customer_id},{attribute/order_line_id}) id: amount_of_active_customers title: '# of Active Customers' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -9212,7 +9212,7 @@ interactions: maql: SELECT COUNT({attribute/order_id}) id: amount_of_orders title: '# of Orders' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -9222,7 +9222,7 @@ interactions: BY {attribute/customer_id}) > 10000 ' id: amount_of_top_customers title: '# of Top Customers' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -9232,7 +9232,7 @@ interactions: IN ("Returned", "Canceled")) id: amount_of_valid_orders title: '# of Valid Orders' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -9242,7 +9242,7 @@ interactions: maql: SELECT SUM({fact/spend}) id: campaign_spend title: Campaign Spend - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -9251,7 +9251,7 @@ interactions: maql: SELECT SUM({fact/price}*{fact/quantity}) id: order_amount title: Order Amount - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -9260,7 +9260,7 @@ interactions: maql: SELECT {metric/revenue} / {metric/total_revenue} id: percent_revenue title: '% Revenue' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -9270,7 +9270,7 @@ interactions: \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" id: percent_revenue_from_top_10_customers title: '% Revenue from Top 10 Customers' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -9280,7 +9280,7 @@ interactions: \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" id: percent_revenue_from_top_10_percent_customers title: '% Revenue from Top 10% Customers' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -9290,7 +9290,7 @@ interactions: \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" id: percent_revenue_from_top_10_percent_products title: '% Revenue from Top 10% Products' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -9300,7 +9300,7 @@ interactions: \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" id: percent_revenue_from_top_10_products title: '% Revenue from Top 10 Products' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -9310,7 +9310,7 @@ interactions: ALL OTHER) id: percent_revenue_in_category title: '% Revenue in Category' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -9319,7 +9319,7 @@ interactions: maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY ALL {attribute/product_id}) id: percent_revenue_per_product title: '% Revenue per Product' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -9329,7 +9329,7 @@ interactions: IN ("Returned", "Canceled")) id: revenue title: Revenue - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -9339,7 +9339,7 @@ interactions: maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Clothing") id: revenue-clothing title: Revenue (Clothing) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -9349,7 +9349,7 @@ interactions: "Electronics") id: revenue-electronic title: Revenue (Electronic) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -9358,7 +9358,7 @@ interactions: maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Home") id: revenue-home title: Revenue (Home) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -9367,7 +9367,7 @@ interactions: maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Outdoor") id: revenue-outdoor title: Revenue (Outdoor) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -9376,7 +9376,7 @@ interactions: maql: SELECT AVG(SELECT {metric/revenue} BY {attribute/customer_id}) id: revenue_per_customer title: Revenue per Customer - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -9385,7 +9385,7 @@ interactions: maql: SELECT {metric/revenue} / {metric/campaign_spend} id: revenue_per_dollar_spent title: Revenue per Dollar Spent - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -9394,7 +9394,7 @@ interactions: maql: SELECT {metric/revenue} WHERE TOP(10) OF ({metric/revenue}) id: revenue_top_10 title: Revenue / Top 10 - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -9403,7 +9403,7 @@ interactions: maql: SELECT {metric/revenue} WHERE TOP(10%) OF ({metric/revenue}) id: revenue_top_10_percent title: Revenue / Top 10% - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -9412,7 +9412,7 @@ interactions: maql: SELECT {metric/revenue} BY ALL OTHER id: total_revenue title: Total Revenue - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -9421,7 +9421,7 @@ interactions: maql: SELECT {metric/total_revenue} WITHOUT PARENT FILTER id: total_revenue-no_filters title: Total Revenue (No Filters) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -9486,7 +9486,7 @@ interactions: visualizationUrl: local:treemap id: campaign_spend title: Campaign Spend - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -9562,7 +9562,7 @@ interactions: visualizationUrl: local:combo2 id: customers_trend title: Customers Trend - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -9641,7 +9641,7 @@ interactions: visualizationUrl: local:table id: percent_revenue_per_product_by_customer_and_category title: '% Revenue per Product by Customer and Category' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -9700,7 +9700,7 @@ interactions: visualizationUrl: local:area id: percentage_of_customers_by_region title: Percentage of Customers by Region - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -9757,7 +9757,7 @@ interactions: visualizationUrl: local:treemap id: product_breakdown title: Product Breakdown - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -9810,7 +9810,7 @@ interactions: visualizationUrl: local:donut id: product_categories_pie_chart title: Product Categories Pie Chart - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -9885,7 +9885,7 @@ interactions: visualizationUrl: local:column id: product_revenue_comparison-over_previous_period title: Product Revenue Comparison (over previous period) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -9942,7 +9942,7 @@ interactions: visualizationUrl: local:scatter id: product_saleability title: Product Saleability - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -10041,7 +10041,7 @@ interactions: visualizationUrl: local:table id: revenue_and_quantity_by_product_and_category title: Revenue and Quantity by Product and Category - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -10097,7 +10097,7 @@ interactions: visualizationUrl: local:line id: revenue_by_category_trend title: Revenue by Category Trend - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -10136,7 +10136,7 @@ interactions: visualizationUrl: local:bar id: revenue_by_product title: Revenue by Product - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -10192,7 +10192,7 @@ interactions: visualizationUrl: local:scatter id: revenue_per_usd_vs_spend_by_campaign title: Revenue per $ vs Spend by Campaign - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -10260,7 +10260,7 @@ interactions: visualizationUrl: local:combo2 id: revenue_trend title: Revenue Trend - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -10317,7 +10317,7 @@ interactions: visualizationUrl: local:bar id: top_10_customers title: Top 10 Customers - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -10374,7 +10374,7 @@ interactions: visualizationUrl: local:bar id: top_10_products title: Top 10 Products - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -10787,7 +10787,7 @@ interactions: drills: [] properties: {} version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -10830,7 +10830,7 @@ interactions: type: dashboardPlugin version: '2' version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -10980,7 +10980,7 @@ interactions: drills: [] properties: {} version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -10992,7 +10992,7 @@ interactions: - content: url: https://www.example.com version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11002,7 +11002,7 @@ interactions: - content: url: https://www.example.com version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11053,7 +11053,7 @@ interactions: - content: format: '#,##0' maql: SELECT COUNT({attribute/customer_id},{attribute/order_line_id}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11062,7 +11062,7 @@ interactions: - content: format: '#,##0' maql: SELECT COUNT({attribute/order_id}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11072,7 +11072,7 @@ interactions: format: '#,##0' maql: 'SELECT {metric/amount_of_active_customers} WHERE (SELECT {metric/revenue} BY {attribute/customer_id}) > 10000 ' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11082,7 +11082,7 @@ interactions: format: '#,##0.00' maql: SELECT {metric/amount_of_orders} WHERE NOT ({label/order_status} IN ("Returned", "Canceled")) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11092,7 +11092,7 @@ interactions: - content: format: $#,##0 maql: SELECT SUM({fact/spend}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11101,7 +11101,7 @@ interactions: - content: format: $#,##0 maql: SELECT SUM({fact/price}*{fact/quantity}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11110,7 +11110,7 @@ interactions: - content: format: '#,##0.0%' maql: SELECT {metric/revenue} / {metric/total_revenue} - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11120,7 +11120,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10}\ \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11130,7 +11130,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10_percent}\ \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11140,7 +11140,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10_percent}\ \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11150,7 +11150,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10}\ \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11160,7 +11160,7 @@ interactions: format: '#,##0.0%' maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY {attribute/products.category}, ALL OTHER) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11170,7 +11170,7 @@ interactions: format: '#,##0.0%' maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY ALL {attribute/product_id}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11180,7 +11180,7 @@ interactions: format: $#,##0 maql: SELECT {metric/order_amount} WHERE NOT ({label/order_status} IN ("Returned", "Canceled")) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11191,7 +11191,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Clothing") - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11201,7 +11201,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ( "Electronics") - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11211,7 +11211,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Home") - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11221,7 +11221,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Outdoor") - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11230,7 +11230,7 @@ interactions: - content: format: $#,##0.0 maql: SELECT AVG(SELECT {metric/revenue} BY {attribute/customer_id}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11239,7 +11239,7 @@ interactions: - content: format: $#,##0.0 maql: SELECT {metric/revenue} / {metric/campaign_spend} - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11248,7 +11248,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} WHERE TOP(10) OF ({metric/revenue}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11257,7 +11257,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} WHERE TOP(10%) OF ({metric/revenue}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11266,7 +11266,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} BY ALL OTHER - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11275,7 +11275,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/total_revenue} WITHOUT PARENT FILTER - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11340,7 +11340,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:treemap - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11416,7 +11416,7 @@ interactions: rotation: auto version: '2' visualizationUrl: local:combo2 - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11495,7 +11495,7 @@ interactions: direction: asc version: '2' visualizationUrl: local:table - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11554,7 +11554,7 @@ interactions: stackMeasuresToPercent: true version: '2' visualizationUrl: local:area - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11611,7 +11611,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:treemap - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11664,7 +11664,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:donut - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11739,7 +11739,7 @@ interactions: visible: false version: '2' visualizationUrl: local:column - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11796,7 +11796,7 @@ interactions: enabled: true version: '2' visualizationUrl: local:scatter - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11895,7 +11895,7 @@ interactions: direction: asc version: '2' visualizationUrl: local:table - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11951,7 +11951,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:line - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -11990,7 +11990,7 @@ interactions: properties: {} version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -12046,7 +12046,7 @@ interactions: min: '0' version: '2' visualizationUrl: local:scatter - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -12114,7 +12114,7 @@ interactions: rotation: auto version: '2' visualizationUrl: local:combo2 - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -12171,7 +12171,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -12228,7 +12228,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -12868,7 +12868,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: 14e6dea02719e7d710061514429fb56d + traceId: 9a11830d6c24fbc99273f23b2ddce133 - request: method: POST uri: http://localhost:3000/api/v1/entities/workspaces @@ -13504,7 +13504,7 @@ interactions: version: '2' id: campaign title: Campaign - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -13547,7 +13547,7 @@ interactions: version: '2' id: dashboard_plugin title: Dashboard plugin - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -13697,7 +13697,7 @@ interactions: version: '2' id: product_and_category title: Product & Category - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -13710,7 +13710,7 @@ interactions: version: '2' id: dashboard_plugin_1 title: dashboard_plugin_1 - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -13720,7 +13720,7 @@ interactions: version: '2' id: dashboard_plugin_2 title: dashboard_plugin_2 - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -13769,7 +13769,7 @@ interactions: maql: SELECT COUNT({attribute/customer_id},{attribute/order_line_id}) id: amount_of_active_customers title: '# of Active Customers' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -13778,7 +13778,7 @@ interactions: maql: SELECT COUNT({attribute/order_id}) id: amount_of_orders title: '# of Orders' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -13788,7 +13788,7 @@ interactions: BY {attribute/customer_id}) > 10000 ' id: amount_of_top_customers title: '# of Top Customers' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -13798,7 +13798,7 @@ interactions: IN ("Returned", "Canceled")) id: amount_of_valid_orders title: '# of Valid Orders' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -13808,7 +13808,7 @@ interactions: maql: SELECT SUM({fact/spend}) id: campaign_spend title: Campaign Spend - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -13817,7 +13817,7 @@ interactions: maql: SELECT SUM({fact/price}*{fact/quantity}) id: order_amount title: Order Amount - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -13826,7 +13826,7 @@ interactions: maql: SELECT {metric/revenue} / {metric/total_revenue} id: percent_revenue title: '% Revenue' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -13836,7 +13836,7 @@ interactions: \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" id: percent_revenue_from_top_10_customers title: '% Revenue from Top 10 Customers' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -13846,7 +13846,7 @@ interactions: \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" id: percent_revenue_from_top_10_percent_customers title: '% Revenue from Top 10% Customers' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -13856,7 +13856,7 @@ interactions: \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" id: percent_revenue_from_top_10_percent_products title: '% Revenue from Top 10% Products' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -13866,7 +13866,7 @@ interactions: \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" id: percent_revenue_from_top_10_products title: '% Revenue from Top 10 Products' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -13876,7 +13876,7 @@ interactions: ALL OTHER) id: percent_revenue_in_category title: '% Revenue in Category' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -13885,7 +13885,7 @@ interactions: maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY ALL {attribute/product_id}) id: percent_revenue_per_product title: '% Revenue per Product' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -13895,7 +13895,7 @@ interactions: IN ("Returned", "Canceled")) id: revenue title: Revenue - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -13905,7 +13905,7 @@ interactions: maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Clothing") id: revenue-clothing title: Revenue (Clothing) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -13915,7 +13915,7 @@ interactions: "Electronics") id: revenue-electronic title: Revenue (Electronic) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -13924,7 +13924,7 @@ interactions: maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Home") id: revenue-home title: Revenue (Home) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -13933,7 +13933,7 @@ interactions: maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Outdoor") id: revenue-outdoor title: Revenue (Outdoor) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -13942,7 +13942,7 @@ interactions: maql: SELECT AVG(SELECT {metric/revenue} BY {attribute/customer_id}) id: revenue_per_customer title: Revenue per Customer - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -13951,7 +13951,7 @@ interactions: maql: SELECT {metric/revenue} / {metric/campaign_spend} id: revenue_per_dollar_spent title: Revenue per Dollar Spent - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -13960,7 +13960,7 @@ interactions: maql: SELECT {metric/revenue} WHERE TOP(10) OF ({metric/revenue}) id: revenue_top_10 title: Revenue / Top 10 - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -13969,7 +13969,7 @@ interactions: maql: SELECT {metric/revenue} WHERE TOP(10%) OF ({metric/revenue}) id: revenue_top_10_percent title: Revenue / Top 10% - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -13978,7 +13978,7 @@ interactions: maql: SELECT {metric/revenue} BY ALL OTHER id: total_revenue title: Total Revenue - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -13987,7 +13987,7 @@ interactions: maql: SELECT {metric/total_revenue} WITHOUT PARENT FILTER id: total_revenue-no_filters title: Total Revenue (No Filters) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -14052,7 +14052,7 @@ interactions: visualizationUrl: local:treemap id: campaign_spend title: Campaign Spend - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -14128,7 +14128,7 @@ interactions: visualizationUrl: local:combo2 id: customers_trend title: Customers Trend - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -14207,7 +14207,7 @@ interactions: visualizationUrl: local:table id: percent_revenue_per_product_by_customer_and_category title: '% Revenue per Product by Customer and Category' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -14266,7 +14266,7 @@ interactions: visualizationUrl: local:area id: percentage_of_customers_by_region title: Percentage of Customers by Region - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -14323,7 +14323,7 @@ interactions: visualizationUrl: local:treemap id: product_breakdown title: Product Breakdown - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -14376,7 +14376,7 @@ interactions: visualizationUrl: local:donut id: product_categories_pie_chart title: Product Categories Pie Chart - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -14451,7 +14451,7 @@ interactions: visualizationUrl: local:column id: product_revenue_comparison-over_previous_period title: Product Revenue Comparison (over previous period) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -14508,7 +14508,7 @@ interactions: visualizationUrl: local:scatter id: product_saleability title: Product Saleability - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -14607,7 +14607,7 @@ interactions: visualizationUrl: local:table id: revenue_and_quantity_by_product_and_category title: Revenue and Quantity by Product and Category - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -14663,7 +14663,7 @@ interactions: visualizationUrl: local:line id: revenue_by_category_trend title: Revenue by Category Trend - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -14702,7 +14702,7 @@ interactions: visualizationUrl: local:bar id: revenue_by_product title: Revenue by Product - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -14758,7 +14758,7 @@ interactions: visualizationUrl: local:scatter id: revenue_per_usd_vs_spend_by_campaign title: Revenue per $ vs Spend by Campaign - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -14826,7 +14826,7 @@ interactions: visualizationUrl: local:combo2 id: revenue_trend title: Revenue Trend - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -14883,7 +14883,7 @@ interactions: visualizationUrl: local:bar id: top_10_customers title: Top 10 Customers - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -14940,7 +14940,7 @@ interactions: visualizationUrl: local:bar id: top_10_products title: Top 10 Products - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/demo_create_workspace.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/demo_create_workspace.yaml index 7c6e6a76d..99967929d 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/demo_create_workspace.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/demo_create_workspace.yaml @@ -120,7 +120,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: 2c7dc1659fdf086b804ccfd27df09196 + traceId: ab9435c494e935835f154e87d7fc55e8 - request: method: POST uri: http://localhost:3000/api/v1/entities/workspaces diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/demo_put_declarative_workspace.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/demo_put_declarative_workspace.yaml index 60220cf52..d6a2acae3 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/demo_put_declarative_workspace.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/demo_put_declarative_workspace.yaml @@ -33,7 +33,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: 73148193ea2432e16487161972e8a7a1 + traceId: dd0dca8f5f6d6a5171e65fd1869541ff - request: method: POST uri: http://localhost:3000/api/v1/entities/workspaces diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/demo_store_declarative_workspaces.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/demo_store_declarative_workspaces.yaml index f4ad456ef..0bd05b8f2 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/demo_store_declarative_workspaces.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/demo_store_declarative_workspaces.yaml @@ -138,7 +138,7 @@ interactions: drills: [] properties: {} version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -181,7 +181,7 @@ interactions: type: dashboardPlugin version: '2' version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -332,7 +332,7 @@ interactions: drills: [] properties: {} version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -344,7 +344,7 @@ interactions: - content: url: https://www.example.com version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -354,7 +354,7 @@ interactions: - content: url: https://www.example.com version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -405,7 +405,7 @@ interactions: - content: format: '#,##0' maql: SELECT COUNT({attribute/customer_id},{attribute/order_line_id}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -414,7 +414,7 @@ interactions: - content: format: '#,##0' maql: SELECT COUNT({attribute/order_id}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -424,7 +424,7 @@ interactions: format: '#,##0' maql: 'SELECT {metric/amount_of_active_customers} WHERE (SELECT {metric/revenue} BY {attribute/customer_id}) > 10000 ' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -434,7 +434,7 @@ interactions: format: '#,##0.00' maql: SELECT {metric/amount_of_orders} WHERE NOT ({label/order_status} IN ("Returned", "Canceled")) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -444,7 +444,7 @@ interactions: - content: format: $#,##0 maql: SELECT SUM({fact/spend}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -453,7 +453,7 @@ interactions: - content: format: $#,##0 maql: SELECT SUM({fact/price}*{fact/quantity}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -462,7 +462,7 @@ interactions: - content: format: '#,##0.0%' maql: SELECT {metric/revenue} / {metric/total_revenue} - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -472,7 +472,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10}\ \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -482,7 +482,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10_percent}\ \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -492,7 +492,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10_percent}\ \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -502,7 +502,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10}\ \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -512,7 +512,7 @@ interactions: format: '#,##0.0%' maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY {attribute/products.category}, ALL OTHER) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -522,7 +522,7 @@ interactions: format: '#,##0.0%' maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY ALL {attribute/product_id}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -532,7 +532,7 @@ interactions: format: $#,##0 maql: SELECT {metric/order_amount} WHERE NOT ({label/order_status} IN ("Returned", "Canceled")) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -543,7 +543,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Clothing") - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -553,7 +553,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ( "Electronics") - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -563,7 +563,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Home") - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -573,7 +573,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Outdoor") - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -582,7 +582,7 @@ interactions: - content: format: $#,##0.0 maql: SELECT AVG(SELECT {metric/revenue} BY {attribute/customer_id}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -591,7 +591,7 @@ interactions: - content: format: $#,##0.0 maql: SELECT {metric/revenue} / {metric/campaign_spend} - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -600,7 +600,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} WHERE TOP(10) OF ({metric/revenue}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -609,7 +609,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} WHERE TOP(10%) OF ({metric/revenue}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -618,7 +618,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} BY ALL OTHER - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -627,7 +627,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/total_revenue} WITHOUT PARENT FILTER - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -692,7 +692,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:treemap - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -768,7 +768,7 @@ interactions: rotation: auto version: '2' visualizationUrl: local:combo2 - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -847,7 +847,7 @@ interactions: direction: asc version: '2' visualizationUrl: local:table - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -906,7 +906,7 @@ interactions: stackMeasuresToPercent: true version: '2' visualizationUrl: local:area - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -963,7 +963,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:treemap - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1016,7 +1016,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:donut - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1091,7 +1091,7 @@ interactions: visible: false version: '2' visualizationUrl: local:column - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1148,7 +1148,7 @@ interactions: enabled: true version: '2' visualizationUrl: local:scatter - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1247,7 +1247,7 @@ interactions: direction: asc version: '2' visualizationUrl: local:table - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1303,7 +1303,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:line - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1342,7 +1342,7 @@ interactions: properties: {} version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1398,7 +1398,7 @@ interactions: min: '0' version: '2' visualizationUrl: local:scatter - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1466,7 +1466,7 @@ interactions: rotation: auto version: '2' visualizationUrl: local:combo2 - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1523,7 +1523,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1580,7 +1580,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2164,7 +2164,7 @@ interactions: drills: [] properties: {} version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2207,7 +2207,7 @@ interactions: type: dashboardPlugin version: '2' version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2358,7 +2358,7 @@ interactions: drills: [] properties: {} version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2370,7 +2370,7 @@ interactions: - content: url: https://www.example.com version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2380,7 +2380,7 @@ interactions: - content: url: https://www.example.com version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2431,7 +2431,7 @@ interactions: - content: format: '#,##0' maql: SELECT COUNT({attribute/customer_id},{attribute/order_line_id}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2440,7 +2440,7 @@ interactions: - content: format: '#,##0' maql: SELECT COUNT({attribute/order_id}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2450,7 +2450,7 @@ interactions: format: '#,##0' maql: 'SELECT {metric/amount_of_active_customers} WHERE (SELECT {metric/revenue} BY {attribute/customer_id}) > 10000 ' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2460,7 +2460,7 @@ interactions: format: '#,##0.00' maql: SELECT {metric/amount_of_orders} WHERE NOT ({label/order_status} IN ("Returned", "Canceled")) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2470,7 +2470,7 @@ interactions: - content: format: $#,##0 maql: SELECT SUM({fact/spend}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2479,7 +2479,7 @@ interactions: - content: format: $#,##0 maql: SELECT SUM({fact/price}*{fact/quantity}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2488,7 +2488,7 @@ interactions: - content: format: '#,##0.0%' maql: SELECT {metric/revenue} / {metric/total_revenue} - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2498,7 +2498,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10}\ \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2508,7 +2508,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10_percent}\ \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2518,7 +2518,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10_percent}\ \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2528,7 +2528,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10}\ \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2538,7 +2538,7 @@ interactions: format: '#,##0.0%' maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY {attribute/products.category}, ALL OTHER) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2548,7 +2548,7 @@ interactions: format: '#,##0.0%' maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY ALL {attribute/product_id}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2558,7 +2558,7 @@ interactions: format: $#,##0 maql: SELECT {metric/order_amount} WHERE NOT ({label/order_status} IN ("Returned", "Canceled")) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2569,7 +2569,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Clothing") - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2579,7 +2579,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ( "Electronics") - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2589,7 +2589,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Home") - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2599,7 +2599,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Outdoor") - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2608,7 +2608,7 @@ interactions: - content: format: $#,##0.0 maql: SELECT AVG(SELECT {metric/revenue} BY {attribute/customer_id}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2617,7 +2617,7 @@ interactions: - content: format: $#,##0.0 maql: SELECT {metric/revenue} / {metric/campaign_spend} - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2626,7 +2626,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} WHERE TOP(10) OF ({metric/revenue}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2635,7 +2635,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} WHERE TOP(10%) OF ({metric/revenue}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2644,7 +2644,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} BY ALL OTHER - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2653,7 +2653,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/total_revenue} WITHOUT PARENT FILTER - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2718,7 +2718,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:treemap - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2794,7 +2794,7 @@ interactions: rotation: auto version: '2' visualizationUrl: local:combo2 - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2873,7 +2873,7 @@ interactions: direction: asc version: '2' visualizationUrl: local:table - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2932,7 +2932,7 @@ interactions: stackMeasuresToPercent: true version: '2' visualizationUrl: local:area - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2989,7 +2989,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:treemap - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3042,7 +3042,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:donut - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3117,7 +3117,7 @@ interactions: visible: false version: '2' visualizationUrl: local:column - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3174,7 +3174,7 @@ interactions: enabled: true version: '2' visualizationUrl: local:scatter - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3273,7 +3273,7 @@ interactions: direction: asc version: '2' visualizationUrl: local:table - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3329,7 +3329,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:line - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3368,7 +3368,7 @@ interactions: properties: {} version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3424,7 +3424,7 @@ interactions: min: '0' version: '2' visualizationUrl: local:scatter - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3492,7 +3492,7 @@ interactions: rotation: auto version: '2' visualizationUrl: local:combo2 - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3549,7 +3549,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3606,7 +3606,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/demo_translate_workspace.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/demo_translate_workspace.yaml index f7cea9f34..d5999396e 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/demo_translate_workspace.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/demo_translate_workspace.yaml @@ -139,7 +139,7 @@ interactions: drills: [] properties: {} version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -182,7 +182,7 @@ interactions: type: dashboardPlugin version: '2' version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -332,7 +332,7 @@ interactions: drills: [] properties: {} version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -344,7 +344,7 @@ interactions: - content: url: https://www.example.com version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -354,7 +354,7 @@ interactions: - content: url: https://www.example.com version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -405,7 +405,7 @@ interactions: - content: format: '#,##0' maql: SELECT COUNT({attribute/customer_id},{attribute/order_line_id}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -414,7 +414,7 @@ interactions: - content: format: '#,##0' maql: SELECT COUNT({attribute/order_id}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -424,7 +424,7 @@ interactions: format: '#,##0' maql: 'SELECT {metric/amount_of_active_customers} WHERE (SELECT {metric/revenue} BY {attribute/customer_id}) > 10000 ' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -434,7 +434,7 @@ interactions: format: '#,##0.00' maql: SELECT {metric/amount_of_orders} WHERE NOT ({label/order_status} IN ("Returned", "Canceled")) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -444,7 +444,7 @@ interactions: - content: format: $#,##0 maql: SELECT SUM({fact/spend}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -453,7 +453,7 @@ interactions: - content: format: $#,##0 maql: SELECT SUM({fact/price}*{fact/quantity}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -462,7 +462,7 @@ interactions: - content: format: '#,##0.0%' maql: SELECT {metric/revenue} / {metric/total_revenue} - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -472,7 +472,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10}\ \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -482,7 +482,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10_percent}\ \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -492,7 +492,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10_percent}\ \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -502,7 +502,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10}\ \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -512,7 +512,7 @@ interactions: format: '#,##0.0%' maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY {attribute/products.category}, ALL OTHER) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -522,7 +522,7 @@ interactions: format: '#,##0.0%' maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY ALL {attribute/product_id}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -532,7 +532,7 @@ interactions: format: $#,##0 maql: SELECT {metric/order_amount} WHERE NOT ({label/order_status} IN ("Returned", "Canceled")) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -543,7 +543,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Clothing") - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -553,7 +553,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ( "Electronics") - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -563,7 +563,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Home") - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -573,7 +573,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Outdoor") - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -582,7 +582,7 @@ interactions: - content: format: $#,##0.0 maql: SELECT AVG(SELECT {metric/revenue} BY {attribute/customer_id}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -591,7 +591,7 @@ interactions: - content: format: $#,##0.0 maql: SELECT {metric/revenue} / {metric/campaign_spend} - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -600,7 +600,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} WHERE TOP(10) OF ({metric/revenue}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -609,7 +609,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} WHERE TOP(10%) OF ({metric/revenue}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -618,7 +618,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} BY ALL OTHER - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -627,7 +627,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/total_revenue} WITHOUT PARENT FILTER - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -692,7 +692,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:treemap - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -768,7 +768,7 @@ interactions: rotation: auto version: '2' visualizationUrl: local:combo2 - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -847,7 +847,7 @@ interactions: direction: asc version: '2' visualizationUrl: local:table - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -906,7 +906,7 @@ interactions: stackMeasuresToPercent: true version: '2' visualizationUrl: local:area - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -963,7 +963,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:treemap - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1016,7 +1016,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:donut - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1091,7 +1091,7 @@ interactions: visible: false version: '2' visualizationUrl: local:column - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1148,7 +1148,7 @@ interactions: enabled: true version: '2' visualizationUrl: local:scatter - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1247,7 +1247,7 @@ interactions: direction: asc version: '2' visualizationUrl: local:table - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1303,7 +1303,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:line - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1342,7 +1342,7 @@ interactions: properties: {} version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1398,7 +1398,7 @@ interactions: min: '0' version: '2' visualizationUrl: local:scatter - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1466,7 +1466,7 @@ interactions: rotation: auto version: '2' visualizationUrl: local:combo2 - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1523,7 +1523,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -1580,7 +1580,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2189,7 +2189,7 @@ interactions: drills: [] properties: {} version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2232,7 +2232,7 @@ interactions: type: dashboardPlugin version: '2' version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2382,7 +2382,7 @@ interactions: drills: [] properties: {} version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2394,7 +2394,7 @@ interactions: - content: url: https://www.example.com version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2404,7 +2404,7 @@ interactions: - content: url: https://www.example.com version: '2' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2455,7 +2455,7 @@ interactions: - content: format: '#,##0' maql: SELECT COUNT({attribute/customer_id},{attribute/order_line_id}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2464,7 +2464,7 @@ interactions: - content: format: '#,##0' maql: SELECT COUNT({attribute/order_id}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2474,7 +2474,7 @@ interactions: format: '#,##0' maql: 'SELECT {metric/amount_of_active_customers} WHERE (SELECT {metric/revenue} BY {attribute/customer_id}) > 10000 ' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2484,7 +2484,7 @@ interactions: format: '#,##0.00' maql: SELECT {metric/amount_of_orders} WHERE NOT ({label/order_status} IN ("Returned", "Canceled")) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2494,7 +2494,7 @@ interactions: - content: format: $#,##0 maql: SELECT SUM({fact/spend}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2503,7 +2503,7 @@ interactions: - content: format: $#,##0 maql: SELECT SUM({fact/price}*{fact/quantity}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2512,7 +2512,7 @@ interactions: - content: format: '#,##0.0%' maql: SELECT {metric/revenue} / {metric/total_revenue} - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2522,7 +2522,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10}\ \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2532,7 +2532,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10_percent}\ \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2542,7 +2542,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10_percent}\ \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2552,7 +2552,7 @@ interactions: format: '#,##0.0%' maql: "SELECT\n (SELECT {metric/revenue} WHERE (SELECT {metric/revenue_top_10}\ \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2562,7 +2562,7 @@ interactions: format: '#,##0.0%' maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY {attribute/products.category}, ALL OTHER) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2572,7 +2572,7 @@ interactions: format: '#,##0.0%' maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY ALL {attribute/product_id}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2582,7 +2582,7 @@ interactions: format: $#,##0 maql: SELECT {metric/order_amount} WHERE NOT ({label/order_status} IN ("Returned", "Canceled")) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2593,7 +2593,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Clothing") - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2603,7 +2603,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ( "Electronics") - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2613,7 +2613,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Home") - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2623,7 +2623,7 @@ interactions: format: $#,##0 maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Outdoor") - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2632,7 +2632,7 @@ interactions: - content: format: $#,##0.0 maql: SELECT AVG(SELECT {metric/revenue} BY {attribute/customer_id}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2641,7 +2641,7 @@ interactions: - content: format: $#,##0.0 maql: SELECT {metric/revenue} / {metric/campaign_spend} - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2650,7 +2650,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} WHERE TOP(10) OF ({metric/revenue}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2659,7 +2659,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} WHERE TOP(10%) OF ({metric/revenue}) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2668,7 +2668,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/revenue} BY ALL OTHER - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2677,7 +2677,7 @@ interactions: - content: format: $#,##0 maql: SELECT {metric/total_revenue} WITHOUT PARENT FILTER - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2742,7 +2742,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:treemap - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2818,7 +2818,7 @@ interactions: rotation: auto version: '2' visualizationUrl: local:combo2 - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2897,7 +2897,7 @@ interactions: direction: asc version: '2' visualizationUrl: local:table - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -2956,7 +2956,7 @@ interactions: stackMeasuresToPercent: true version: '2' visualizationUrl: local:area - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3013,7 +3013,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:treemap - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3066,7 +3066,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:donut - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3141,7 +3141,7 @@ interactions: visible: false version: '2' visualizationUrl: local:column - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3198,7 +3198,7 @@ interactions: enabled: true version: '2' visualizationUrl: local:scatter - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3297,7 +3297,7 @@ interactions: direction: asc version: '2' visualizationUrl: local:table - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3353,7 +3353,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:line - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3392,7 +3392,7 @@ interactions: properties: {} version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3448,7 +3448,7 @@ interactions: min: '0' version: '2' visualizationUrl: local:scatter - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3516,7 +3516,7 @@ interactions: rotation: auto version: '2' visualizationUrl: local:combo2 - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3573,7 +3573,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -3630,7 +3630,7 @@ interactions: position: bottom version: '2' visualizationUrl: local:bar - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4032,7 +4032,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: 555a29a2b1b191898684c0cc2de42f8a + traceId: b13995638ae5a3be512e38800559a7ec - request: method: POST uri: http://localhost:3000/api/v1/entities/workspaces @@ -4654,7 +4654,7 @@ interactions: version: '2' id: campaign title: Campaign - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4697,7 +4697,7 @@ interactions: version: '2' id: dashboard_plugin title: Dashboard plugin - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4847,7 +4847,7 @@ interactions: version: '2' id: product_and_category title: Product & Category - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4860,7 +4860,7 @@ interactions: version: '2' id: dashboard_plugin_1 title: dashboard_plugin_1 - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4870,7 +4870,7 @@ interactions: version: '2' id: dashboard_plugin_2 title: dashboard_plugin_2 - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4919,7 +4919,7 @@ interactions: maql: SELECT COUNT({attribute/customer_id},{attribute/order_line_id}) id: amount_of_active_customers title: '# of Active Customers' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4928,7 +4928,7 @@ interactions: maql: SELECT COUNT({attribute/order_id}) id: amount_of_orders title: '# of Orders' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4938,7 +4938,7 @@ interactions: BY {attribute/customer_id}) > 10000 ' id: amount_of_top_customers title: '# of Top Customers' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4948,7 +4948,7 @@ interactions: IN ("Returned", "Canceled")) id: amount_of_valid_orders title: '# of Valid Orders' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4958,7 +4958,7 @@ interactions: maql: SELECT SUM({fact/spend}) id: campaign_spend title: Campaign Spend - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4967,7 +4967,7 @@ interactions: maql: SELECT SUM({fact/price}*{fact/quantity}) id: order_amount title: Order Amount - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4976,7 +4976,7 @@ interactions: maql: SELECT {metric/revenue} / {metric/total_revenue} id: percent_revenue title: '% Revenue' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4986,7 +4986,7 @@ interactions: \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" id: percent_revenue_from_top_10_customers title: '% Revenue from Top 10 Customers' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -4996,7 +4996,7 @@ interactions: \ BY {attribute/customer_id}) > 0)\n /\n {metric/revenue}" id: percent_revenue_from_top_10_percent_customers title: '% Revenue from Top 10% Customers' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5006,7 +5006,7 @@ interactions: \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" id: percent_revenue_from_top_10_percent_products title: '% Revenue from Top 10% Products' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5016,7 +5016,7 @@ interactions: \ BY {attribute/product_id}) > 0)\n /\n {metric/revenue}" id: percent_revenue_from_top_10_products title: '% Revenue from Top 10 Products' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5026,7 +5026,7 @@ interactions: ALL OTHER) id: percent_revenue_in_category title: '% Revenue in Category' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5035,7 +5035,7 @@ interactions: maql: SELECT {metric/revenue} / (SELECT {metric/revenue} BY ALL {attribute/product_id}) id: percent_revenue_per_product title: '% Revenue per Product' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5045,7 +5045,7 @@ interactions: IN ("Returned", "Canceled")) id: revenue title: Revenue - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5055,7 +5055,7 @@ interactions: maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Clothing") id: revenue-clothing title: Revenue (Clothing) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5065,7 +5065,7 @@ interactions: "Electronics") id: revenue-electronic title: Revenue (Electronic) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5074,7 +5074,7 @@ interactions: maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Home") id: revenue-home title: Revenue (Home) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5083,7 +5083,7 @@ interactions: maql: SELECT {metric/revenue} WHERE {label/products.category} IN ("Outdoor") id: revenue-outdoor title: Revenue (Outdoor) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5092,7 +5092,7 @@ interactions: maql: SELECT AVG(SELECT {metric/revenue} BY {attribute/customer_id}) id: revenue_per_customer title: Revenue per Customer - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5101,7 +5101,7 @@ interactions: maql: SELECT {metric/revenue} / {metric/campaign_spend} id: revenue_per_dollar_spent title: Revenue per Dollar Spent - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5110,7 +5110,7 @@ interactions: maql: SELECT {metric/revenue} WHERE TOP(10) OF ({metric/revenue}) id: revenue_top_10 title: Revenue / Top 10 - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5119,7 +5119,7 @@ interactions: maql: SELECT {metric/revenue} WHERE TOP(10%) OF ({metric/revenue}) id: revenue_top_10_percent title: Revenue / Top 10% - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5128,7 +5128,7 @@ interactions: maql: SELECT {metric/revenue} BY ALL OTHER id: total_revenue title: Total Revenue - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5137,7 +5137,7 @@ interactions: maql: SELECT {metric/total_revenue} WITHOUT PARENT FILTER id: total_revenue-no_filters title: Total Revenue (No Filters) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5202,7 +5202,7 @@ interactions: visualizationUrl: local:treemap id: campaign_spend title: Campaign Spend - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5278,7 +5278,7 @@ interactions: visualizationUrl: local:combo2 id: customers_trend title: Customers Trend - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5357,7 +5357,7 @@ interactions: visualizationUrl: local:table id: percent_revenue_per_product_by_customer_and_category title: '% Revenue per Product by Customer and Category' - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5416,7 +5416,7 @@ interactions: visualizationUrl: local:area id: percentage_of_customers_by_region title: Percentage of Customers by Region - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5473,7 +5473,7 @@ interactions: visualizationUrl: local:treemap id: product_breakdown title: Product Breakdown - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5526,7 +5526,7 @@ interactions: visualizationUrl: local:donut id: product_categories_pie_chart title: Product Categories Pie Chart - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5601,7 +5601,7 @@ interactions: visualizationUrl: local:column id: product_revenue_comparison-over_previous_period title: Product Revenue Comparison (over previous period) - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5658,7 +5658,7 @@ interactions: visualizationUrl: local:scatter id: product_saleability title: Product Saleability - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5757,7 +5757,7 @@ interactions: visualizationUrl: local:table id: revenue_and_quantity_by_product_and_category title: Revenue and Quantity by Product and Category - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5813,7 +5813,7 @@ interactions: visualizationUrl: local:line id: revenue_by_category_trend title: Revenue by Category Trend - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5852,7 +5852,7 @@ interactions: visualizationUrl: local:bar id: revenue_by_product title: Revenue by Product - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5908,7 +5908,7 @@ interactions: visualizationUrl: local:scatter id: revenue_per_usd_vs_spend_by_campaign title: Revenue per $ vs Spend by Campaign - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -5976,7 +5976,7 @@ interactions: visualizationUrl: local:combo2 id: revenue_trend title: Revenue Trend - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -6033,7 +6033,7 @@ interactions: visualizationUrl: local:bar id: top_10_customers title: Top 10 Customers - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -6090,7 +6090,7 @@ interactions: visualizationUrl: local:bar id: top_10_products title: Top 10 Products - createdAt: 2026-03-11 10:03 + createdAt: 2026-03-12 09:09 createdBy: id: admin type: user @@ -6252,7 +6252,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: deeb52b57153198bacf3476e7f0502c4 + traceId: 83f2f804b07ba58d4d7ac53f328ea71f - request: method: POST uri: http://localhost:3000/api/v1/entities/workspaces/demo_cs/workspaceSettings @@ -6363,7 +6363,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: 65462493e2ca9d2f18ae154fe33fcf7b + traceId: b2ebea0e27d0ef2454f9120b405837ee - request: method: POST uri: http://localhost:3000/api/v1/entities/workspaces/demo_cs/workspaceSettings diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/layout_automations.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/layout_automations.yaml index 11d49c386..3bd269165 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/layout_automations.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/layout_automations.yaml @@ -232,48 +232,6 @@ interactions: - '0' body: string: '' - - request: - method: GET - uri: http://localhost:3000/api/v1/layout/workspaces/demo/automations - body: null - headers: - Accept: - - application/json - Accept-Encoding: - - br, gzip, deflate - X-GDC-VALIDATE-RELATIONS: - - 'true' - X-Requested-With: - - XMLHttpRequest - response: - status: - code: 200 - message: OK - headers: - Cache-Control: - - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '2' - Content-Type: - - application/json - DATE: *id001 - Expires: - - '0' - Pragma: - - no-cache - Referrer-Policy: - - no-referrer - Vary: - - Origin - - Access-Control-Request-Method - - Access-Control-Request-Headers - X-Content-Type-Options: - - nosniff - X-GDC-TRACE-ID: *id001 - X-Xss-Protection: - - '0' - body: - string: [] - request: method: PUT uri: http://localhost:3000/api/v1/layout/notificationChannels diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/layout_filter_views.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/layout_filter_views.yaml index ed3f99405..365e0e45e 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/layout_filter_views.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/layout_filter_views.yaml @@ -226,45 +226,3 @@ interactions: - '0' body: string: '' - - request: - method: GET - uri: http://localhost:3000/api/v1/layout/workspaces/demo/filterViews - body: null - headers: - Accept: - - application/json - Accept-Encoding: - - br, gzip, deflate - X-GDC-VALIDATE-RELATIONS: - - 'true' - X-Requested-With: - - XMLHttpRequest - response: - status: - code: 200 - message: OK - headers: - Cache-Control: - - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '2' - Content-Type: - - application/json - DATE: *id001 - Expires: - - '0' - Pragma: - - no-cache - Referrer-Policy: - - no-referrer - Vary: - - Origin - - Access-Control-Request-Method - - Access-Control-Request-Headers - X-Content-Type-Options: - - nosniff - X-GDC-TRACE-ID: *id001 - X-Xss-Protection: - - '0' - body: - string: [] diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/list_workspace_settings.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/list_workspace_settings.yaml index f5a9f57e5..97009e9d2 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/list_workspace_settings.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/list_workspace_settings.yaml @@ -48,7 +48,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: 46bece586d177879ccc7c2ce22d1110a + traceId: 4e9622fe47516fd93084cb14ba7ff433 - request: method: POST uri: http://localhost:3000/api/v1/entities/workspaces/demo/workspaceSettings @@ -159,7 +159,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: 4afaa65642fe94bd56c65dcc993f08a3 + traceId: 266ac1f3e7b2a7d3dd1a5c6d73d33fef - request: method: POST uri: http://localhost:3000/api/v1/entities/workspaces/demo/workspaceSettings @@ -370,49 +370,3 @@ interactions: - '0' body: string: '' - - request: - method: GET - uri: http://localhost:3000/api/v1/entities/workspaces/demo/workspaceSettings?page=0&size=500 - body: null - headers: - Accept: - - application/json - Accept-Encoding: - - br, gzip, deflate - X-GDC-VALIDATE-RELATIONS: - - 'true' - X-Requested-With: - - XMLHttpRequest - response: - status: - code: 200 - message: OK - headers: - Cache-Control: - - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '215' - Content-Type: - - application/json - DATE: *id001 - Expires: - - '0' - Pragma: - - no-cache - Referrer-Policy: - - no-referrer - Vary: - - Origin - - Access-Control-Request-Method - - Access-Control-Request-Headers - X-Content-Type-Options: - - nosniff - X-GDC-TRACE-ID: *id001 - X-Xss-Protection: - - '0' - body: - string: - data: [] - links: - self: http://localhost:3000/api/v1/entities/workspaces/demo/workspaceSettings?page=0&size=500 - next: http://localhost:3000/api/v1/entities/workspaces/demo/workspaceSettings?page=1&size=500 diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/update_workspace_setting.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/update_workspace_setting.yaml index 516b03adf..edbcb72b2 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/update_workspace_setting.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/update_workspace_setting.yaml @@ -48,7 +48,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: 1111ea3b997c80a084651cdcf5b4d46b + traceId: b70e336739c072a944a549880acdb40f - request: method: POST uri: http://localhost:3000/api/v1/entities/workspaces/demo/workspaceSettings @@ -380,49 +380,3 @@ interactions: - '0' body: string: '' - - request: - method: GET - uri: http://localhost:3000/api/v1/entities/workspaces/demo/workspaceSettings?page=0&size=500 - body: null - headers: - Accept: - - application/json - Accept-Encoding: - - br, gzip, deflate - X-GDC-VALIDATE-RELATIONS: - - 'true' - X-Requested-With: - - XMLHttpRequest - response: - status: - code: 200 - message: OK - headers: - Cache-Control: - - no-cache, no-store, max-age=0, must-revalidate - Content-Length: - - '215' - Content-Type: - - application/json - DATE: *id001 - Expires: - - '0' - Pragma: - - no-cache - Referrer-Policy: - - no-referrer - Vary: - - Origin - - Access-Control-Request-Method - - Access-Control-Request-Headers - X-Content-Type-Options: - - nosniff - X-GDC-TRACE-ID: *id001 - X-Xss-Protection: - - '0' - body: - string: - data: [] - links: - self: http://localhost:3000/api/v1/entities/workspaces/demo/workspaceSettings?page=0&size=500 - next: http://localhost:3000/api/v1/entities/workspaces/demo/workspaceSettings?page=1&size=500 diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/user_data_filters_for_user_group.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/user_data_filters_for_user_group.yaml index d12ce5b5e..caabb8330 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/user_data_filters_for_user_group.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/user_data_filters_for_user_group.yaml @@ -94,7 +94,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: 6b0aa4594d623a8c1d3f2b5775f2b6fa + traceId: 95fdae5a19854b68c6fa8c8de25007d2 - request: method: POST uri: http://localhost:3000/api/v1/entities/workspaces/demo/userDataFilters diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/user_data_filters_life_cycle.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/user_data_filters_life_cycle.yaml index 910bab2f9..58cd5421e 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/user_data_filters_life_cycle.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/workspaces/user_data_filters_life_cycle.yaml @@ -94,7 +94,7 @@ interactions: to access it. status: 404 title: Not Found - traceId: 800d6105b05daebbc854cc386cba3497 + traceId: 3049820f8bb4c67d7f61da7cf8e56c47 - request: method: POST uri: http://localhost:3000/api/v1/entities/workspaces/demo/userDataFilters @@ -241,7 +241,7 @@ interactions: self: http://localhost:3000/api/v1/entities/workspaces/demo/labels/order_status type: label - attributes: - authenticationId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + authenticationId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs firstname: Demo lastname: User email: demo@example.com @@ -316,7 +316,7 @@ interactions: type: userDataFilter included: - attributes: - authenticationId: CiQyMjUyMzlmOS02NzliLTQ2ODUtYjg1ZS1lYjlhYTk4OWY2YzISBWxvY2Fs + authenticationId: CiQ0NGY5Y2QxNy1hYmYzLTRhZjctOGVhMi0wOGI0MTVkOWU0NDMSBWxvY2Fs firstname: Demo lastname: User email: demo@example.com diff --git a/packages/gooddata-sdk/tests/export/fixtures/test_export_csv.yaml b/packages/gooddata-sdk/tests/export/fixtures/test_export_csv.yaml index 053dc1f4b..0d35f85d1 100644 --- a/packages/gooddata-sdk/tests/export/fixtures/test_export_csv.yaml +++ b/packages/gooddata-sdk/tests/export/fixtures/test_export_csv.yaml @@ -84,7 +84,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - aa751220-c950-48a7-9dcb-e8ec289bd689 + - 9acb68b6-adb1-482c-8452-ba27525f2659 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -132,14 +132,14 @@ interactions: name: Order Amount localIdentifier: dim_1 links: - executionResult: 19249ca61d703a2ac2db233738c34942fb62726a:adcd8577837f00f2cea677417ba72f3750a8944f5ad6855f76dd420230c57171 + executionResult: 8e23014420a05d8da240a7a628362877bd30c3db:e954e81cf9b9b87caa8ac3694648e8848f9de534d830a80fa245b5975b1106cd - request: method: POST uri: http://localhost:3000/api/v1/actions/workspaces/demo/export/tabular body: fileName: test_csv format: CSV - executionResult: 19249ca61d703a2ac2db233738c34942fb62726a:adcd8577837f00f2cea677417ba72f3750a8944f5ad6855f76dd420230c57171 + executionResult: 8e23014420a05d8da240a7a628362877bd30c3db:e954e81cf9b9b87caa8ac3694648e8848f9de534d830a80fa245b5975b1106cd customOverride: labels: region: @@ -191,10 +191,10 @@ interactions: - '0' body: string: - exportResult: f88645a9ab39d4699e8f7c09b926f09c3a0a0ee2 + exportResult: 84e4dc28d3dac44173c9509cf0fbd3ae551c7c75 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/export/tabular/f88645a9ab39d4699e8f7c09b926f09c3a0a0ee2 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/export/tabular/84e4dc28d3dac44173c9509cf0fbd3ae551c7c75 body: null headers: Accept: @@ -235,7 +235,7 @@ interactions: string: '' - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/export/tabular/f88645a9ab39d4699e8f7c09b926f09c3a0a0ee2 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/export/tabular/84e4dc28d3dac44173c9509cf0fbd3ae551c7c75 body: null headers: Accept: @@ -276,7 +276,7 @@ interactions: string: '' - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/export/tabular/f88645a9ab39d4699e8f7c09b926f09c3a0a0ee2 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/export/tabular/84e4dc28d3dac44173c9509cf0fbd3ae551c7c75 body: null headers: Accept: diff --git a/packages/gooddata-sdk/tests/export/fixtures/test_export_csv_by_visualization_id.yaml b/packages/gooddata-sdk/tests/export/fixtures/test_export_csv_by_visualization_id.yaml index 2ef9a5ac1..d59bf1aba 100644 --- a/packages/gooddata-sdk/tests/export/fixtures/test_export_csv_by_visualization_id.yaml +++ b/packages/gooddata-sdk/tests/export/fixtures/test_export_csv_by_visualization_id.yaml @@ -118,7 +118,7 @@ interactions: rotation: auto version: '2' visualizationUrl: local:combo2 - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: customers_trend meta: origin: @@ -165,7 +165,7 @@ interactions: content: format: '#,##0' maql: SELECT COUNT({attribute/customer_id},{attribute/order_line_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: amount_of_active_customers links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/amount_of_active_customers @@ -175,7 +175,7 @@ interactions: content: format: $#,##0.0 maql: SELECT AVG(SELECT {metric/revenue} BY {attribute/customer_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue_per_customer links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue_per_customer @@ -240,10 +240,10 @@ interactions: - '0' body: string: - exportResult: 3fba0097d0c306fc7e1b2dc0502e8eff6272e82e + exportResult: 7d0a0fcd684bf46ac7c689e220edb8faf425eded - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/export/tabular/3fba0097d0c306fc7e1b2dc0502e8eff6272e82e + uri: http://localhost:3000/api/v1/actions/workspaces/demo/export/tabular/7d0a0fcd684bf46ac7c689e220edb8faf425eded body: null headers: Accept: @@ -284,7 +284,7 @@ interactions: string: '' - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/export/tabular/3fba0097d0c306fc7e1b2dc0502e8eff6272e82e + uri: http://localhost:3000/api/v1/actions/workspaces/demo/export/tabular/7d0a0fcd684bf46ac7c689e220edb8faf425eded body: null headers: Accept: @@ -325,7 +325,7 @@ interactions: string: '' - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/export/tabular/3fba0097d0c306fc7e1b2dc0502e8eff6272e82e + uri: http://localhost:3000/api/v1/actions/workspaces/demo/export/tabular/7d0a0fcd684bf46ac7c689e220edb8faf425eded body: null headers: Accept: @@ -366,7 +366,7 @@ interactions: string: '' - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/export/tabular/3fba0097d0c306fc7e1b2dc0502e8eff6272e82e + uri: http://localhost:3000/api/v1/actions/workspaces/demo/export/tabular/7d0a0fcd684bf46ac7c689e220edb8faf425eded body: null headers: Accept: @@ -407,7 +407,7 @@ interactions: string: '' - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/export/tabular/3fba0097d0c306fc7e1b2dc0502e8eff6272e82e + uri: http://localhost:3000/api/v1/actions/workspaces/demo/export/tabular/7d0a0fcd684bf46ac7c689e220edb8faf425eded body: null headers: Accept: diff --git a/packages/gooddata-sdk/tests/export/fixtures/test_export_excel.yaml b/packages/gooddata-sdk/tests/export/fixtures/test_export_excel.yaml index 05308364a..680aa251b 100644 --- a/packages/gooddata-sdk/tests/export/fixtures/test_export_excel.yaml +++ b/packages/gooddata-sdk/tests/export/fixtures/test_export_excel.yaml @@ -84,7 +84,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 5cd5c617-a69d-4547-9691-6089712badfc + - 90cf6cf0-4eb8-4c89-9c9f-8de9b78a9a19 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -132,14 +132,14 @@ interactions: name: Order Amount localIdentifier: dim_1 links: - executionResult: 19249ca61d703a2ac2db233738c34942fb62726a:adcd8577837f00f2cea677417ba72f3750a8944f5ad6855f76dd420230c57171 + executionResult: 8e23014420a05d8da240a7a628362877bd30c3db:e954e81cf9b9b87caa8ac3694648e8848f9de534d830a80fa245b5975b1106cd - request: method: POST uri: http://localhost:3000/api/v1/actions/workspaces/demo/export/tabular body: fileName: test_xlsx format: XLSX - executionResult: 19249ca61d703a2ac2db233738c34942fb62726a:adcd8577837f00f2cea677417ba72f3750a8944f5ad6855f76dd420230c57171 + executionResult: 8e23014420a05d8da240a7a628362877bd30c3db:e954e81cf9b9b87caa8ac3694648e8848f9de534d830a80fa245b5975b1106cd customOverride: labels: region: @@ -191,10 +191,10 @@ interactions: - '0' body: string: - exportResult: 746dfb76a9e58dde63332538504c45b57a484eb3 + exportResult: 5e9f8a9e472033e69f188345404ab8c4c5a519e3 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/export/tabular/746dfb76a9e58dde63332538504c45b57a484eb3 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/export/tabular/5e9f8a9e472033e69f188345404ab8c4c5a519e3 body: null headers: Accept: @@ -235,7 +235,7 @@ interactions: string: '' - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/export/tabular/746dfb76a9e58dde63332538504c45b57a484eb3 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/export/tabular/5e9f8a9e472033e69f188345404ab8c4c5a519e3 body: null headers: Accept: @@ -257,7 +257,7 @@ interactions: Content-Disposition: - attachment; filename="=?UTF-8?Q?test=5Fxlsx.xlsx?="; filename*=UTF-8''test_xlsx.xlsx Content-Length: - - '7541' + - '7540' Content-Type: - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet DATE: *id001 @@ -385,29 +385,29 @@ interactions: dr6GmVPXn68zRmWfmasr0+J3SI4IG2TV28zst1A06yalI3Lc6aDZpuoahv3/8OTjrph8zh4PFoLc 88wirtb0tUfBxtupcM5Hbd1scd1b+1GbwuEDZV/QuKnw2WK+HfADiD6aT5QIEvFSqyy/+eYQdG5p xmWs/tkxahGC1op4X+TwqTm7scLZZ4t7c2d7Bl97Z7vaXi5RWzvI5KulP5748D7I3oGD0oQpWbxN - egBHze7sLwPgYy9It/4GUEsDBBQAAAAIAAAAPwA7DVm1JQEAAFACAAARAAAAZG9jUHJvcHMvY29y - ZS54bWydks1qwzAQhO99CqO7LclOQxG2A23JqYFCU1p6E9ImEbV+kNQ6efsqTuIkkFOPq5n9dnZR - PdvqLvsFH5Q1DaIFQRkYYaUy6wa9L+f5A8pC5Ebyzhpo0A4CmrV3tXBMWA+v3jrwUUHIEsgEJlyD - NjE6hnEQG9A8FMlhkriyXvOYSr/GjotvvgZcEjLFGiKXPHK8B+ZuJKIjUooR6X58NwCkwNCBBhMD - pgXFZ28Er8PNhkG5cGoVdw5uWk/i6N4GNRr7vi/6arCm/BR/Ll7ehlVzZfanEoDaWgomPPBofVvj - yyIdruMhLtKJVwrk4y7pN96Oixz6QGYpADvEPSkf1dPzco7akpTTnFQ5pUtKGJmwyf3XfuRV/xmo - j0P+TTwBDrmvP0H7B1BLAwQUAAAACAAAAD8ABHFFY3sBAAATAwAAEAAAAGRvY1Byb3BzL2FwcC54 - bWydUsFO4zAQvfMVke/UabVaocoxWpVd9bCISi1wXBln0lh1bMszRClfj5OqIYU94dObN0/PzzMW - t11jsxYiGu8KNp/lLAOnfWncvmCPuz/XNyxDUq5U1jso2BGQ3corsYk+QCQDmCUHhwWricKSc9Q1 - NApnqe1Sp/KxUZTKuOe+qoyGO69fG3DEF3n+k0NH4Eoor8NoyE6Oy5a+a1p63efDp90xJD8pfoVg - jVaUHinvjY4efUXZ706DFXzaFMloC/o1GjrKXPBpKbZaWVglY1kpiyD4ByHWoPqZbZSJKEVLyxY0 - +ZiheUtTW7DsRSH0cQrWqmiUI3aSnYoB24AU5bOPB6wBCAUfyQFOtVNsfsj5IEjgUsjHIAlfRtwZ - soAP1UZF+k/i+TTxkIFNMhIg/essdl8ini/7ZL/yTVAuzZCP6K9xB3wMO3+nCM4TvSTFtlYRyrSE - ceIjIdYpWrS9flUrt4fyrPna6Pf/dPrjcr6Y5ekMaz9zgn98Z/kOUEsBAhQDFAAAAAgAAAA/AGFd - STpPAQAAjwQAABMAAAAAAAAAAAAAAICBAAAAAFtDb250ZW50X1R5cGVzXS54bWxQSwECFAMUAAAA - CAAAAD8A8p9J2ukAAABLAgAACwAAAAAAAAAAAAAAgIGAAQAAX3JlbHMvLnJlbHNQSwECFAMUAAAA - CAAAAD8ARHVb8OgAAAC5AgAAGgAAAAAAAAAAAAAAgIGSAgAAeGwvX3JlbHMvd29ya2Jvb2sueG1s - LnJlbHNQSwECFAMUAAAACAAAAD8ADJjQDFIHAAAgIwAAGAAAAAAAAAAAAAAAgIGyAwAAeGwvd29y - a3NoZWV0cy9zaGVldDEueG1sUEsBAhQDFAAAAAgAAAA/AAjizPlMAQAAKQIAAA8AAAAAAAAAAAAA - AICBOgsAAHhsL3dvcmtib29rLnhtbFBLAQIUAxQAAAAIAAAAPwB1V3+oEgIAADAGAAAUAAAAAAAA - AAAAAACAgbMMAAB4bC9zaGFyZWRTdHJpbmdzLnhtbFBLAQIUAxQAAAAIAAAAPwBdnzo03wIAAIwP - AAANAAAAAAAAAAAAAACAgfcOAAB4bC9zdHlsZXMueG1sUEsBAhQDFAAAAAgAAAA/ABj6RlSwBQAA - UhsAABMAAAAAAAAAAAAAAICBARIAAHhsL3RoZW1lL3RoZW1lMS54bWxQSwECFAMUAAAACAAAAD8A - Ow1ZtSUBAABQAgAAEQAAAAAAAAAAAAAAgIHiFwAAZG9jUHJvcHMvY29yZS54bWxQSwECFAMUAAAA - CAAAAD8ABHFFY3sBAAATAwAAEAAAAAAAAAAAAAAAgIE2GQAAZG9jUHJvcHMvYXBwLnhtbFBLBQYA - AAAACgAKAIACAADfGgAAAAA= + egBHze7sLwPgYy9It/4GUEsDBBQAAAAIAAAAPwBQB2UTJAEAAFACAAARAAAAZG9jUHJvcHMvY29y + ZS54bWydks1qwzAQhO99CqO7LdmG0Arbgbbk1EChKS29CWnjiFo/SGqdvH0VO3ES8KmgizSz384u + qpZ71SW/4Lw0ukZ5RlACmhshdVuj980qvUeJD0wL1hkNNTqAR8vmruKWcuPg1RkLLkjwSQRpT7mt + 0S4ESzH2fAeK+Sw6dBS3xikW4tW12DL+zVrABSELrCAwwQLDR2BqJyI6IQWfkPbHdQNAcAwdKNDB + 4zzL8cUbwCk/WzAoV04lw8HCrPUsTu69l5Ox7/usLwdrzJ/jz/XL2zBqKvVxVRxQUwlOuQMWjGsq + fH2Ji+uYD+u44q0E8XiI+szbaZCxDkQSA9Ax7ln5KJ+eNyvUFKRYpKRM82JDHmhO4vk6trypvwDV + qcm/iWfAmPv2EzR/UEsDBBQAAAAIAAAAPwAEcUVjewEAABMDAAAQAAAAZG9jUHJvcHMvYXBwLnht + bJ1SwU7jMBC98xWR79RptVqhyjFalV31sIhKLXBcGWfSWHVsyzNEKV+Pk6ohhT3h05s3T8/PMxa3 + XWOzFiIa7wo2n+UsA6d9ady+YI+7P9c3LENSrlTWOyjYEZDdyiuxiT5AJAOYJQeHBauJwpJz1DU0 + Cmep7VKn8rFRlMq4576qjIY7r18bcMQXef6TQ0fgSiivw2jITo7Llr5rWnrd58On3TEkPyl+hWCN + VpQeKe+Njh59RdnvToMVfNoUyWgL+jUaOspc8GkptlpZWCVjWSmLIPgHIdag+pltlIkoRUvLFjT5 + mKF5S1NbsOxFIfRxCtaqaJQjdpKdigHbgBTls48HrAEIBR/JAU61U2x+yPkgSOBSyMcgCV9G3Bmy + gA/VRkX6T+L5NPGQgU0yEiD96yx2XyKeL/tkv/JNUC7NkI/or3EHfAw7f6cIzhO9JMW2VhHKtIRx + 4iMh1ilatL1+VSu3h/Ks+dro9/90+uNyvpjl6QxrP3OCf3xn+Q5QSwECFAMUAAAACAAAAD8AYV1J + Ok8BAACPBAAAEwAAAAAAAAAAAAAAgIEAAAAAW0NvbnRlbnRfVHlwZXNdLnhtbFBLAQIUAxQAAAAI + AAAAPwDyn0na6QAAAEsCAAALAAAAAAAAAAAAAACAgYABAABfcmVscy8ucmVsc1BLAQIUAxQAAAAI + AAAAPwBEdVvw6AAAALkCAAAaAAAAAAAAAAAAAACAgZICAAB4bC9fcmVscy93b3JrYm9vay54bWwu + cmVsc1BLAQIUAxQAAAAIAAAAPwAMmNAMUgcAACAjAAAYAAAAAAAAAAAAAACAgbIDAAB4bC93b3Jr + c2hlZXRzL3NoZWV0MS54bWxQSwECFAMUAAAACAAAAD8ACOLM+UwBAAApAgAADwAAAAAAAAAAAAAA + gIE6CwAAeGwvd29ya2Jvb2sueG1sUEsBAhQDFAAAAAgAAAA/AHVXf6gSAgAAMAYAABQAAAAAAAAA + AAAAAICBswwAAHhsL3NoYXJlZFN0cmluZ3MueG1sUEsBAhQDFAAAAAgAAAA/AF2fOjTfAgAAjA8A + AA0AAAAAAAAAAAAAAICB9w4AAHhsL3N0eWxlcy54bWxQSwECFAMUAAAACAAAAD8AGPpGVLAFAABS + GwAAEwAAAAAAAAAAAAAAgIEBEgAAeGwvdGhlbWUvdGhlbWUxLnhtbFBLAQIUAxQAAAAIAAAAPwBQ + B2UTJAEAAFACAAARAAAAAAAAAAAAAACAgeIXAABkb2NQcm9wcy9jb3JlLnhtbFBLAQIUAxQAAAAI + AAAAPwAEcUVjewEAABMDAAAQAAAAAAAAAAAAAACAgTUZAABkb2NQcm9wcy9hcHAueG1sUEsFBgAA + AAAKAAoAgAIAAN4aAAAAAA== diff --git a/packages/gooddata-sdk/tests/export/fixtures/test_export_excel_by_visualization_id.yaml b/packages/gooddata-sdk/tests/export/fixtures/test_export_excel_by_visualization_id.yaml index f073ddc8b..6eb99640d 100644 --- a/packages/gooddata-sdk/tests/export/fixtures/test_export_excel_by_visualization_id.yaml +++ b/packages/gooddata-sdk/tests/export/fixtures/test_export_excel_by_visualization_id.yaml @@ -118,7 +118,7 @@ interactions: rotation: auto version: '2' visualizationUrl: local:combo2 - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: customers_trend meta: origin: @@ -165,7 +165,7 @@ interactions: content: format: '#,##0' maql: SELECT COUNT({attribute/customer_id},{attribute/order_line_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: amount_of_active_customers links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/amount_of_active_customers @@ -175,7 +175,7 @@ interactions: content: format: $#,##0.0 maql: SELECT AVG(SELECT {metric/revenue} BY {attribute/customer_id}) - createdAt: 2026-03-11 10:04 + createdAt: 2026-03-12 09:09 id: revenue_per_customer links: self: http://localhost:3000/api/v1/entities/workspaces/demo/metrics/revenue_per_customer @@ -240,10 +240,10 @@ interactions: - '0' body: string: - exportResult: 563340250604606b8496e373ed75e320b144155d + exportResult: 50f5d55249ecca42c6eda885ff36392cbdb06451 - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/export/tabular/563340250604606b8496e373ed75e320b144155d + uri: http://localhost:3000/api/v1/actions/workspaces/demo/export/tabular/50f5d55249ecca42c6eda885ff36392cbdb06451 body: null headers: Accept: @@ -284,7 +284,7 @@ interactions: string: '' - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/export/tabular/563340250604606b8496e373ed75e320b144155d + uri: http://localhost:3000/api/v1/actions/workspaces/demo/export/tabular/50f5d55249ecca42c6eda885ff36392cbdb06451 body: null headers: Accept: @@ -325,7 +325,7 @@ interactions: string: '' - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/export/tabular/563340250604606b8496e373ed75e320b144155d + uri: http://localhost:3000/api/v1/actions/workspaces/demo/export/tabular/50f5d55249ecca42c6eda885ff36392cbdb06451 body: null headers: Accept: @@ -366,7 +366,7 @@ interactions: string: '' - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/export/tabular/563340250604606b8496e373ed75e320b144155d + uri: http://localhost:3000/api/v1/actions/workspaces/demo/export/tabular/50f5d55249ecca42c6eda885ff36392cbdb06451 body: null headers: Accept: @@ -407,7 +407,7 @@ interactions: string: '' - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/export/tabular/563340250604606b8496e373ed75e320b144155d + uri: http://localhost:3000/api/v1/actions/workspaces/demo/export/tabular/50f5d55249ecca42c6eda885ff36392cbdb06451 body: null headers: Accept: @@ -448,7 +448,7 @@ interactions: string: '' - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/export/tabular/563340250604606b8496e373ed75e320b144155d + uri: http://localhost:3000/api/v1/actions/workspaces/demo/export/tabular/50f5d55249ecca42c6eda885ff36392cbdb06451 body: null headers: Accept: @@ -470,7 +470,7 @@ interactions: Content-Disposition: - attachment; filename="=?UTF-8?Q?Customers_Trend.xlsx?="; filename*=UTF-8''Customers%20Trend.xlsx Content-Length: - - '6035' + - '6034' Content-Type: - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet DATE: *id001 @@ -572,28 +572,28 @@ interactions: t1A06yalI3Lc6aDZpuoahv3/8OTjrph8zh4PFoLc88wirtb0tUfBxtupcM5Hbd1scd1b+1GbwuED ZV/QuKnw2WK+HfADiD6aT5QIEvFSqyy/+eYQdG5pxmWs/tkxahGC1op4X+TwqTm7scLZZ4t7c2d7 Bl97Z7vaXi5RWzvI5KulP5748D7I3oGD0oQpWbxNegBHze7sLwPgYy9It/4GUEsDBBQAAAAIAAAA - PwDNN5Z5JQEAAFACAAARAAAAZG9jUHJvcHMvY29yZS54bWydks1qwzAQhO99CqO7LSluQxG2A23J - qYFCU1pyE9ImEbV+kNQ6efsqTuIk4FOPq5n9dnZRNdvpNvsFH5Q1NaIFQRkYYaUymxp9LOf5I8pC - 5Eby1hqo0R4CmjV3lXBMWA9v3jrwUUHIEsgEJlyNtjE6hnEQW9A8FMlhkri2XvOYSr/BjotvvgE8 - IWSKNUQueeT4AMzdQEQnpBQD0v34tgdIgaEFDSYGTAuKL94IXofRhl65cmoV9w5GrWdxcO+CGoxd - 1xVd2VtTfoq/Fq/v/aq5ModTCUBNJQUTHni0vqnwdZEO1/IQF+nEawXyaZ/0kbfTIsc+kFkKwI5x - z8pn+fyynKNmQibTnJQ5pUtKGLlnD+XqMPKm/wLUpyH/Jp4Bx9y3n6D5A1BLAwQUAAAACAAAAD8A - ssAyR34BAAAZAwAAEAAAAGRvY1Byb3BzL2FwcC54bWydUsFO6zAQvPMVke/UaYXQU+UYoQLiwNOr - 1ABn42waC8e2vNuofV+Pk6ohBU7kNDs7Gk92V9zsW5t1ENF4V7D5LGcZOO0r47YFey4fLv+wDEm5 - SlnvoGAHQHYjL8Q6+gCRDGCWHBwWrCEKS85RN9AqnKW2S53ax1ZRKuOW+7o2Gu683rXgiC/y/JrD - nsBVUF2G0ZAdHZcd/da08rrPhy/lISQ/KW5DsEYrSj8p/xodPfqasvu9Biv4tCmS0Qb0Lho6yFzw - aSk2WllYJWNZK4sg+CchHkH1M1srE1GKjpYdaPIxQ/M/TW3BsjeF0McpWKeiUY7YUXYsBmwDUpSv - Pr5jA0Ao+EgOcKqdYnMl54MggXMhH4MkfB6xNGQB/9VrFemHxPNp4iEDm2Rc7ZB8m64mK2Na37eg - pye/PLLybVAuTZKP6Mm4d3wOpb9TBKe5npNi06gIVVrFOPeREI8pYLS9ftUot4XqpPne6K/g5Xjp - cr6Y5ekbln/iBP88avkBUEsBAhQDFAAAAAgAAAA/AGFdSTpPAQAAjwQAABMAAAAAAAAAAAAAAICB - AAAAAFtDb250ZW50X1R5cGVzXS54bWxQSwECFAMUAAAACAAAAD8A8p9J2ukAAABLAgAACwAAAAAA - AAAAAAAAgIGAAQAAX3JlbHMvLnJlbHNQSwECFAMUAAAACAAAAD8ARHVb8OgAAAC5AgAAGgAAAAAA - AAAAAAAAgIGSAgAAeGwvX3JlbHMvd29ya2Jvb2sueG1sLnJlbHNQSwECFAMUAAAACAAAAD8Akm+C - GrICAADjBwAAGAAAAAAAAAAAAAAAgIGyAwAAeGwvd29ya3NoZWV0cy9zaGVldDEueG1sUEsBAhQD - FAAAAAgAAAA/AO9t+qtPAQAALwIAAA8AAAAAAAAAAAAAAICBmgYAAHhsL3dvcmtib29rLnhtbFBL - AQIUAxQAAAAIAAAAPwDtxIIjugAAAAQBAAAUAAAAAAAAAAAAAACAgRYIAAB4bC9zaGFyZWRTdHJp - bmdzLnhtbFBLAQIUAxQAAAAIAAAAPwCvZpxJ7wIAALANAAANAAAAAAAAAAAAAACAgQIJAAB4bC9z - dHlsZXMueG1sUEsBAhQDFAAAAAgAAAA/ABj6RlSwBQAAUhsAABMAAAAAAAAAAAAAAICBHAwAAHhs - L3RoZW1lL3RoZW1lMS54bWxQSwECFAMUAAAACAAAAD8AzTeWeSUBAABQAgAAEQAAAAAAAAAAAAAA - gIH9EQAAZG9jUHJvcHMvY29yZS54bWxQSwECFAMUAAAACAAAAD8AssAyR34BAAAZAwAAEAAAAAAA - AAAAAAAAgIFREwAAZG9jUHJvcHMvYXBwLnhtbFBLBQYAAAAACgAKAIACAAD9FAAAAAA= + PwCD9AqHJAEAAFACAAARAAAAZG9jUHJvcHMvY29yZS54bWydkk9rAjEQxe/9FEvuu0lWEBt2V2iL + pwqFWlp6C8mooZs/JGlXv33jqqvCnjxO3pvfvBlSzXe6zf7AB2VNjWhBUAZGWKnMpkYfq0U+Q1mI + 3EjeWgM12kNA8+ahEo4J6+HNWwc+KghZApnAhKvRNkbHMA5iC5qHIjlMEtfWax5T6TfYcfHDN4BL + QqZYQ+SSR44PwNwNRHRCSjEg3a9ve4AUGFrQYGLAtKD44o3gdRht6JUrp1Zx72DUehYH9y6owdh1 + XdFNemvKT/HX8vW9XzVX5nAqAaippGDCA4/WNxW+LtLhWh7iMp14rUA+7ZM+8nZa5NgHMksB2DHu + WfmcPL+sFqgpSTnNySSn5Yo8MkoYnX0fRt70X4D6NORu4hlwzH37CZp/UEsDBBQAAAAIAAAAPwCy + wDJHfgEAABkDAAAQAAAAZG9jUHJvcHMvYXBwLnhtbJ1SwU7rMBC88xWR79RphdBT5RihAuLA06vU + AGfjbBoLx7a826h9X4+TqiEFTuQ0OzsaT3ZX3Oxbm3UQ0XhXsPksZxk47SvjtgV7Lh8u/7AMSblK + We+gYAdAdiMvxDr6AJEMYJYcHBasIQpLzlE30CqcpbZLndrHVlEq45b7ujYa7rzeteCIL/L8msOe + wFVQXYbRkB0dlx391rTyus+HL+UhJD8pbkOwRitKPyn/Gh09+pqy+70GK/i0KZLRBvQuGjrIXPBp + KTZaWVglY1kriyD4JyEeQfUzWysTUYqOlh1o8jFD8z9NbcGyN4XQxylYp6JRjthRdiwGbANSlK8+ + vmMDQCj4SA5wqp1icyXngyCBcyEfgyR8HrE0ZAH/1WsV6YfE82niIQObZFztkHybriYrY1rft6Cn + J788svJtUC5Nko/oybh3fA6lv1MEp7mek2LTqAhVWsU495EQjylgtL1+1Si3heqk+d7or+DleOly + vpjl6RuWf+IE/zxq+QFQSwECFAMUAAAACAAAAD8AYV1JOk8BAACPBAAAEwAAAAAAAAAAAAAAgIEA + AAAAW0NvbnRlbnRfVHlwZXNdLnhtbFBLAQIUAxQAAAAIAAAAPwDyn0na6QAAAEsCAAALAAAAAAAA + AAAAAACAgYABAABfcmVscy8ucmVsc1BLAQIUAxQAAAAIAAAAPwBEdVvw6AAAALkCAAAaAAAAAAAA + AAAAAACAgZICAAB4bC9fcmVscy93b3JrYm9vay54bWwucmVsc1BLAQIUAxQAAAAIAAAAPwCSb4Ia + sgIAAOMHAAAYAAAAAAAAAAAAAACAgbIDAAB4bC93b3Jrc2hlZXRzL3NoZWV0MS54bWxQSwECFAMU + AAAACAAAAD8A7236q08BAAAvAgAADwAAAAAAAAAAAAAAgIGaBgAAeGwvd29ya2Jvb2sueG1sUEsB + AhQDFAAAAAgAAAA/AO3EgiO6AAAABAEAABQAAAAAAAAAAAAAAICBFggAAHhsL3NoYXJlZFN0cmlu + Z3MueG1sUEsBAhQDFAAAAAgAAAA/AK9mnEnvAgAAsA0AAA0AAAAAAAAAAAAAAICBAgkAAHhsL3N0 + eWxlcy54bWxQSwECFAMUAAAACAAAAD8AGPpGVLAFAABSGwAAEwAAAAAAAAAAAAAAgIEcDAAAeGwv + dGhlbWUvdGhlbWUxLnhtbFBLAQIUAxQAAAAIAAAAPwCD9AqHJAEAAFACAAARAAAAAAAAAAAAAACA + gf0RAABkb2NQcm9wcy9jb3JlLnhtbFBLAQIUAxQAAAAIAAAAPwCywDJHfgEAABkDAAAQAAAAAAAA + AAAAAACAgVATAABkb2NQcm9wcy9hcHAueG1sUEsFBgAAAAAKAAoAgAIAAPwUAAAAAA== diff --git a/packages/gooddata-sdk/tests/table/fixtures/table_with_attribute_and_metric.yaml b/packages/gooddata-sdk/tests/table/fixtures/table_with_attribute_and_metric.yaml index 8f0078025..3dff33209 100644 --- a/packages/gooddata-sdk/tests/table/fixtures/table_with_attribute_and_metric.yaml +++ b/packages/gooddata-sdk/tests/table/fixtures/table_with_attribute_and_metric.yaml @@ -68,7 +68,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - fd8841b0-2bb4-4022-9655-6555ac1a6245 + - 454f493e-1804-4fb5-a2ad-50e7c3d299ad X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -100,10 +100,10 @@ interactions: name: Order Amount localIdentifier: dim_1 links: - executionResult: 3353582f1ffe57d37c4d101c2957734fcb8ba586:36545184d66eec6bd4344c8bce561beb26c30bafd5ac18d8014facbdb8b89ddc + executionResult: 30edb2873dfc09415e36a376d4522a0854722352:3112d8e920129b7ba02ee76ce78837fb183f96503586b180be9031c0004aa4cc - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/3353582f1ffe57d37c4d101c2957734fcb8ba586%3A36545184d66eec6bd4344c8bce561beb26c30bafd5ac18d8014facbdb8b89ddc?offset=0%2C0&limit=512%2C256 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/30edb2873dfc09415e36a376d4522a0854722352%3A3112d8e920129b7ba02ee76ce78837fb183f96503586b180be9031c0004aa4cc?offset=0%2C0&limit=512%2C256 body: null headers: Accept: diff --git a/packages/gooddata-sdk/tests/table/fixtures/table_with_attribute_metric_and_filter.yaml b/packages/gooddata-sdk/tests/table/fixtures/table_with_attribute_metric_and_filter.yaml index 477371cbf..25e8d2e72 100644 --- a/packages/gooddata-sdk/tests/table/fixtures/table_with_attribute_metric_and_filter.yaml +++ b/packages/gooddata-sdk/tests/table/fixtures/table_with_attribute_metric_and_filter.yaml @@ -75,7 +75,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 6433b2ed-4e9f-4324-8598-c2e19781c7ee + - 4da5ca54-bb3f-44a7-a53d-9bfd0fe5af76 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -107,10 +107,10 @@ interactions: name: Order Amount localIdentifier: dim_1 links: - executionResult: d63d5e23b671ce38cb37fcc28c6d3e61b26bdabe:b2b0860b7c156b9cd2f217bb2685ee0a38994750e8f5a1d33d4a653233d2fbb9 + executionResult: 3d836c21b282d4df38f4d149661f6e61691b73d5:16125f850aecbc884be0f703e2835ab894d424d9bc6218546b83bb0908cd423b - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/d63d5e23b671ce38cb37fcc28c6d3e61b26bdabe%3Ab2b0860b7c156b9cd2f217bb2685ee0a38994750e8f5a1d33d4a653233d2fbb9?offset=0%2C0&limit=512%2C256 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/3d836c21b282d4df38f4d149661f6e61691b73d5%3A16125f850aecbc884be0f703e2835ab894d424d9bc6218546b83bb0908cd423b?offset=0%2C0&limit=512%2C256 body: null headers: Accept: diff --git a/packages/gooddata-sdk/tests/table/fixtures/table_with_attribute_show_all_values.yaml b/packages/gooddata-sdk/tests/table/fixtures/table_with_attribute_show_all_values.yaml index 186a234bf..067464662 100644 --- a/packages/gooddata-sdk/tests/table/fixtures/table_with_attribute_show_all_values.yaml +++ b/packages/gooddata-sdk/tests/table/fixtures/table_with_attribute_show_all_values.yaml @@ -69,7 +69,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - cfa6c8b1-6a73-4770-b45f-521bd5ec065c + - a0544d78-da6b-4e02-bd9c-08feabeca299 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -103,10 +103,10 @@ interactions: - localIdentifier: metric1 localIdentifier: dim_1 links: - executionResult: 1e970967bed2af57c64d9014e8dfdf90d6419fa5:32766b26d8d35cd48cb1a38d7b1caea9af8ffbfc07f99bafe3f973cd599d2dec + executionResult: 1506e2062e939712141106c9035fbe8d39ad9833:93bf30c989d0ec417ab449efcb688ac41e23b3300affd8e78fdf5dcf6fd1d23e - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/1e970967bed2af57c64d9014e8dfdf90d6419fa5%3A32766b26d8d35cd48cb1a38d7b1caea9af8ffbfc07f99bafe3f973cd599d2dec?offset=0%2C0&limit=512%2C256 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/1506e2062e939712141106c9035fbe8d39ad9833%3A93bf30c989d0ec417ab449efcb688ac41e23b3300affd8e78fdf5dcf6fd1d23e?offset=0%2C0&limit=512%2C256 body: null headers: Accept: @@ -447,7 +447,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 1c8fca83-1bc8-446f-9556-0e870745519f + - 7db61059-f294-4b24-8076-0ebe182acea3 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -481,10 +481,10 @@ interactions: - localIdentifier: metric1 localIdentifier: dim_1 links: - executionResult: 717d68223171188d80abd845a5d1a38374a85822:dda83e69da123c066079d8cf6e45c5cbbf514c9d046659e3e46ec65df7d79f06 + executionResult: ef5cec1d3bd8a3a7408c07fac1d84bfde4a17391:1158c50c8f1273f5bf2abcaccb17095a1f57e0830c32b296513a222310300afc - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/717d68223171188d80abd845a5d1a38374a85822%3Adda83e69da123c066079d8cf6e45c5cbbf514c9d046659e3e46ec65df7d79f06?offset=0%2C0&limit=512%2C256 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/ef5cec1d3bd8a3a7408c07fac1d84bfde4a17391%3A1158c50c8f1273f5bf2abcaccb17095a1f57e0830c32b296513a222310300afc?offset=0%2C0&limit=512%2C256 body: null headers: Accept: @@ -821,7 +821,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 1e417252-c880-4ab1-9e77-4a3e4c1c30e3 + - 8048fb3e-8f76-4a69-a98b-2d35bc1b4b64 X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -855,10 +855,10 @@ interactions: - localIdentifier: metric1 localIdentifier: dim_1 links: - executionResult: 25b092d6ac207685cbb716cc3997ca9a9e47c2ff:349ca016d16777dc663493cdbe66ef4580c95bea3f971d48d5c2a5510cb2ec90 + executionResult: 358e3fde2618c5d707d485c60f1353497b8ffcca:abc65e15cecf678812b7e48f3225583e41c7af4741cc0996bb9a54f65666639b - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/25b092d6ac207685cbb716cc3997ca9a9e47c2ff%3A349ca016d16777dc663493cdbe66ef4580c95bea3f971d48d5c2a5510cb2ec90?offset=0%2C0&limit=512%2C256 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/358e3fde2618c5d707d485c60f1353497b8ffcca%3Aabc65e15cecf678812b7e48f3225583e41c7af4741cc0996bb9a54f65666639b?offset=0%2C0&limit=512%2C256 body: null headers: Accept: diff --git a/packages/gooddata-sdk/tests/table/fixtures/table_with_just_attribute.yaml b/packages/gooddata-sdk/tests/table/fixtures/table_with_just_attribute.yaml index 4ef7a8e4e..e17e731ce 100644 --- a/packages/gooddata-sdk/tests/table/fixtures/table_with_just_attribute.yaml +++ b/packages/gooddata-sdk/tests/table/fixtures/table_with_just_attribute.yaml @@ -56,7 +56,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 345018e5-478d-4a65-b6d6-4325a6819c5d + - b5baa88b-2bba-4e28-b3a7-e738f4d3922d X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -82,10 +82,10 @@ interactions: valueType: TEXT localIdentifier: dim_0 links: - executionResult: 5307b02f0e7ade85ed56fec3f3f6d045e80606f9:b4e5cf2285605b9a694cb90185c8ea021d5d00a7394cd258e10ec810e6bf922b + executionResult: a67d3dbae4fde9f1b5f5de9adc83e24e3a25c02a:fae98a10f6edeeeccac3d9918b1e8db9ef53d8f3518168b6ec724517140669ed - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/5307b02f0e7ade85ed56fec3f3f6d045e80606f9%3Ab4e5cf2285605b9a694cb90185c8ea021d5d00a7394cd258e10ec810e6bf922b?offset=0&limit=512 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/a67d3dbae4fde9f1b5f5de9adc83e24e3a25c02a%3Afae98a10f6edeeeccac3d9918b1e8db9ef53d8f3518168b6ec724517140669ed?offset=0&limit=512 body: null headers: Accept: diff --git a/packages/gooddata-sdk/tests/table/fixtures/table_with_just_metric.yaml b/packages/gooddata-sdk/tests/table/fixtures/table_with_just_metric.yaml index 02e4c7ca7..7b5076e23 100644 --- a/packages/gooddata-sdk/tests/table/fixtures/table_with_just_metric.yaml +++ b/packages/gooddata-sdk/tests/table/fixtures/table_with_just_metric.yaml @@ -60,7 +60,7 @@ interactions: X-Content-Type-Options: - nosniff X-Gdc-Cancel-Token: - - 0f7700d0-47d1-4e50-accb-fadfbd24b65f + - 5b53cdc1-347d-4af5-82bf-2456563f903e X-GDC-TRACE-ID: *id001 X-Xss-Protection: - '0' @@ -75,10 +75,10 @@ interactions: name: Order Amount localIdentifier: dim_0 links: - executionResult: c749add301ea7eb9a0fde48834c2587e678eedc0:e859c5dfaecf546ff96ead5d53d47ee55267d20527c4769aa04fa23ac7789fb0 + executionResult: 8e3f9c91e95b1a78a45622b1fe64e5a1c5abd970:48facf94c3afd60f1459ebf17ec4be27ed9afab46ada7c6e882132298810797e - request: method: GET - uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/c749add301ea7eb9a0fde48834c2587e678eedc0%3Ae859c5dfaecf546ff96ead5d53d47ee55267d20527c4769aa04fa23ac7789fb0?offset=0&limit=256 + uri: http://localhost:3000/api/v1/actions/workspaces/demo/execution/afm/execute/result/8e3f9c91e95b1a78a45622b1fe64e5a1c5abd970%3A48facf94c3afd60f1459ebf17ec4be27ed9afab46ada7c6e882132298810797e?offset=0&limit=256 body: null headers: Accept: diff --git a/packages/tests-support/fixtures/demo_user.json b/packages/tests-support/fixtures/demo_user.json new file mode 100644 index 000000000..694be6bdc --- /dev/null +++ b/packages/tests-support/fixtures/demo_user.json @@ -0,0 +1,19 @@ +{ + "data": { + "id": "demo", + "type": "user", + "attributes": { + "authenticationId": "" + }, + "relationships": { + "userGroups": { + "data": [ + { + "id": "adminGroup", + "type": "userGroup" + } + ] + } + } + } +} diff --git a/packages/tests-support/fixtures/demo_user_auth.json b/packages/tests-support/fixtures/demo_user_auth.json new file mode 100644 index 000000000..dd85f7186 --- /dev/null +++ b/packages/tests-support/fixtures/demo_user_auth.json @@ -0,0 +1,5 @@ +{ + "email": "demo@gooddata.com", + "password": "demo123", + "displayName": "Demo" +} From 038dfb96f47271d181253d9a8bfbc751256e8234 Mon Sep 17 00:00:00 2001 From: Jan Tychtl Date: Thu, 12 Mar 2026 11:25:37 +0100 Subject: [PATCH 4/4] fix(ci): narrow staging workflow dependencies to test group only Co-Authored-By: Claude Opus 4.6 --- .github/workflows/staging-tests.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/staging-tests.yaml b/.github/workflows/staging-tests.yaml index bdedb18ff..9ba1594a5 100644 --- a/.github/workflows/staging-tests.yaml +++ b/.github/workflows/staging-tests.yaml @@ -55,7 +55,7 @@ jobs: python-version: '3.14' - name: Install dependencies - run: uv sync --all-groups --locked + run: uv sync --group test --locked - name: Clean staging environment run: make clean-staging